diff --git a/src/visier_platform_sdk/.openapi-generator-ignore b/src/visier_platform_sdk/.openapi-generator-ignore new file mode 100644 index 0000000000..150c98928f --- /dev/null +++ b/src/visier_platform_sdk/.openapi-generator-ignore @@ -0,0 +1,17 @@ +# Ignore folders +docs/ +.github/ + +# Ignore broken unit test for DTO +test/test_sql_like200_response.py + +# Ignore files in the root by default +/* + +# Allow specific files for PyPI publishing +!setup.py +!setup.cfg +!requirements.txt +!test-requirements.txt +!tox.ini +!pyproject.toml \ No newline at end of file diff --git a/src/visier_platform_sdk/.openapi-generator/FILES b/src/visier_platform_sdk/.openapi-generator/FILES new file mode 100644 index 0000000000..05e02cdc09 --- /dev/null +++ b/src/visier_platform_sdk/.openapi-generator/FILES @@ -0,0 +1,1317 @@ +pyproject.toml +requirements.txt +setup.cfg +setup.py +test-requirements.txt +test/__init__.py +test/test_admin_all_tenants_status_apidto.py +test/test_admin_assign_connector_credentials_by_tenant_response_dto.py +test/test_admin_assign_connector_credentials_response_dto.py +test/test_admin_assign_connector_with_credentials_response_dto.py +test/test_admin_assigned_credential_info_response_dto.py +test/test_admin_batch_tenant_provision_apidto.py +test/test_admin_business_location_dto.py +test/test_admin_connector_info_response_dto.py +test/test_admin_connector_setting_request_dto.py +test/test_admin_connector_setting_response_dto.py +test/test_admin_connector_settings_response_dto.py +test/test_admin_consolidated_analytics_api_excluded_source_list_dto.py +test/test_admin_consolidated_analytics_api_source_tenant_list_dto.py +test/test_admin_consolidated_analytics_api_tenant_create_request_dto.py +test/test_admin_consolidated_analytics_api_tenant_list_response_dto.py +test/test_admin_consolidated_analytics_api_tenant_with_details.py +test/test_admin_consolidated_analytics_api_tenant_with_details_list_response_dto.py +test/test_admin_custom_property_dto.py +test/test_admin_custom_tenant_property_dto.py +test/test_admin_data_import_definition_apidto.py +test/test_admin_data_import_definitions_apidto.py +test/test_admin_data_version_and_date_dto.py +test/test_admin_delete_user_group_v2_request.py +test/test_admin_element_ids_dto.py +test/test_admin_email_domains_dto.py +test/test_admin_excluded_sources_body.py +test/test_admin_extractor_setting_apidto.py +test/test_admin_extractor_setting_key_value_apidto.py +test/test_admin_extractor_settings_apidto.py +test/test_admin_home_analysis_by_user_group_dto.py +test/test_admin_jobs_consolidated_analytics_job_request_dto.py +test/test_admin_jobs_extract_data_and_load_dto.py +test/test_admin_jobs_processing_job_request_dto.py +test/test_admin_key_name.py +test/test_admin_mask_message.py +test/test_admin_multiple_tenant_data_versions_details_dto.py +test/test_admin_multiple_tenant_data_versions_list_dto.py +test/test_admin_network_subnets_message_request.py +test/test_admin_network_subnets_message_response.py +test/test_admin_permission_response_dto.py +test/test_admin_permissions_list_dto.py +test/test_admin_permissions_to_user_group_for_tenant_dto.py +test/test_admin_permissions_to_user_group_request_dto.py +test/test_admin_permissions_to_user_groups_request_dto.py +test/test_admin_product_release_dto.py +test/test_admin_product_releases_dto.py +test/test_admin_product_version_dto.py +test/test_admin_product_versions_dto.py +test/test_admin_product_versions_update_failure_tenant_response_dto.py +test/test_admin_product_versions_update_response_dto.py +test/test_admin_product_versions_update_successful_tenant_response_dto.py +test/test_admin_put_project_commits_request.py +test/test_admin_security_assignment_response_dto.py +test/test_admin_set_connector_setting_request_dto.py +test/test_admin_set_connector_setting_response_dto.py +test/test_admin_set_connector_settings_request_dto.py +test/test_admin_set_connector_settings_response_dto.py +test/test_admin_simple_user_dto.py +test/test_admin_target_project_for_tenant_dto.py +test/test_admin_target_project_for_tenants_list_dto.py +test/test_admin_tenant_assignments_dto.py +test/test_admin_tenant_code_body.py +test/test_admin_tenant_connector_settings_request_dto.py +test/test_admin_tenant_detail_apidto.py +test/test_admin_tenant_details_traits_dto.py +test/test_admin_tenant_management_api_get_response_dto.py +test/test_admin_tenant_management_api_list_response_dto.py +test/test_admin_tenant_management_api_update_request_dto.py +test/test_admin_tenant_management_api_update_response_dto.py +test/test_admin_tenant_provision_apidto.py +test/test_admin_tenant_status_apidto.py +test/test_admin_update_tenant_model.py +test/test_admin_user_group_change_definition_dto.py +test/test_admin_user_group_change_dimension_filter_dto.py +test/test_admin_user_group_change_failure_dto.py +test/test_admin_user_group_change_filter_dto.py +test/test_admin_user_group_change_member_selection_dto.py +test/test_admin_user_group_change_response_dto.py +test/test_admin_user_group_change_success_dto.py +test/test_admin_user_group_change_users_dto.py +test/test_admin_user_group_delete_dto.py +test/test_admin_user_group_delete_failure_dto.py +test/test_admin_user_group_delete_response_dto.py +test/test_admin_user_group_delete_success_dto.py +test/test_admin_user_group_filters_dto.py +test/test_admin_user_group_get_api_response_dto.py +test/test_admin_user_group_single_delete_response_dto.py +test/test_admin_user_groups_change_dto.py +test/test_admin_user_groups_delete_request_dto.py +test/test_admin_user_groups_get_api_response_dto.py +test/test_admin_user_groups_users_dto.py +test/test_admin_user_groups_users_for_tenant_dto.py +test/test_admin_user_security_assignments_dto.py +test/test_admin_users_to_user_group_request_dto.py +test/test_admin_users_to_user_groups_request_dto.py +test/test_analysis_common_report_create_request_dto.py +test/test_analysis_common_report_delete_success_dto.py +test/test_analysis_common_report_dto.py +test/test_analysis_common_report_list_response_dto.py +test/test_analysis_common_vee_clarification_dto.py +test/test_analysis_common_vee_conversation_state_dto.py +test/test_analysis_common_vee_corrections_dto.py +test/test_analysis_common_vee_data_dto.py +test/test_analysis_common_vee_feedback_dto.py +test/test_analysis_common_vee_options_dto.py +test/test_analysis_common_vee_question_dto.py +test/test_analysis_common_vee_response_dto.py +test/test_analysis_common_vee_response_schema_dto.py +test/test_analysis_common_vee_response_schema_reference_dto.py +test/test_analysis_common_vee_sample_question_dto.py +test/test_analysis_common_vee_sample_question_library_dto.py +test/test_analysis_common_vee_status_code_dto.py +test/test_analysis_common_vee_visual_dto.py +test/test_analysis_common_vee_visual_options_dto.py +test/test_api_error.py +test/test_authentication_o_auth2_user_info_dto.py +test/test_authentication_o_auth2_user_subnet_info_dto.py +test/test_authentication_o_auth2_user_tenant_detail_dto.py +test/test_authentication_o_auth2_user_tenant_details_dto.py +test/test_authentication_o_auth2_user_tenant_properties_dto.py +test/test_basic_authentication_api.py +test/test_benchmark_info.py +test/test_benchmark_value.py +test/test_benchmarks_api.py +test/test_concepts_v2_api.py +test/test_consolidated_analytics_api.py +test/test_data_and_job_handling_api.py +test/test_data_in_assign_connector_credential_request.py +test/test_data_in_connector.py +test/test_data_in_data_load_request.py +test/test_data_in_data_load_request_model.py +test/test_data_in_data_load_response.py +test/test_data_in_data_transfer_result_detail.py +test/test_data_in_data_version_object.py +test/test_data_in_disable_dv_model.py +test/test_data_in_disable_dv_request.py +test/test_data_in_disable_dv_response.py +test/test_data_in_dispatching_job_status_response.py +test/test_data_in_exclude_data_uploads_request.py +test/test_data_in_extraction_job.py +test/test_data_in_extraction_job_and_status_response.py +test/test_data_in_include_data_uploads_request.py +test/test_data_in_job_status_list_response.py +test/test_data_in_job_status_with_start_time.py +test/test_data_in_processing_job.py +test/test_data_in_processing_job_and_status_response.py +test/test_data_in_processing_job_status_response.py +test/test_data_in_push_data_cancel_response.py +test/test_data_in_push_data_complete_request.py +test/test_data_in_push_data_complete_response.py +test/test_data_in_push_data_response.py +test/test_data_in_receiving_job.py +test/test_data_in_receiving_job_and_status_response.py +test/test_data_in_receiving_job_status_response.py +test/test_data_in_result.py +test/test_data_in_source.py +test/test_data_in_start_extraction_response.py +test/test_data_in_start_transfer_response.py +test/test_data_in_tenant.py +test/test_data_in_tenant_and_credential.py +test/test_data_in_upload_to_exclude.py +test/test_data_in_upload_to_include.py +test/test_data_intake_api.py +test/test_data_model_api.py +test/test_data_out_list_response.py +test/test_data_query_api.py +test/test_data_upload_api.py +test/test_data_version_export_api.py +test/test_dataservices_common_dimension_member_reference_dto.py +test/test_dataservices_common_member_values_dto.py +test/test_dataservices_datamodel_aggregation_type_option_dto.py +test/test_dataservices_datamodel_aggregation_type_parameter_dto.py +test/test_dataservices_datamodel_analytic_object_dto.py +test/test_dataservices_datamodel_analytic_objects_dto.py +test/test_dataservices_datamodel_currencies_dto.py +test/test_dataservices_datamodel_currency_dto.py +test/test_dataservices_datamodel_currency_rate_dto.py +test/test_dataservices_datamodel_currency_rates_dto.py +test/test_dataservices_datamodel_dimension_dto.py +test/test_dataservices_datamodel_dimension_mapping_validation_dto.py +test/test_dataservices_datamodel_dimension_mapping_validation_execution_dto.py +test/test_dataservices_datamodel_dimension_reference_dto.py +test/test_dataservices_datamodel_dimensions_dto.py +test/test_dataservices_datamodel_level_dto.py +test/test_dataservices_datamodel_member_dto.py +test/test_dataservices_datamodel_member_parameter_definition_dto.py +test/test_dataservices_datamodel_members_dto.py +test/test_dataservices_datamodel_metric_dto.py +test/test_dataservices_datamodel_metrics_dto.py +test/test_dataservices_datamodel_numeric_parameter_definition_dto.py +test/test_dataservices_datamodel_object_reference_dto.py +test/test_dataservices_datamodel_parameter_definition_dto.py +test/test_dataservices_datamodel_plan_parameter_definition_dto.py +test/test_dataservices_datamodel_planning_concept_filter_context_dto.py +test/test_dataservices_datamodel_planning_hierarchy_filter_context_dto.py +test/test_dataservices_datamodel_planning_model_dto.py +test/test_dataservices_datamodel_planning_models_dto.py +test/test_dataservices_datamodel_planning_plan_context_dto.py +test/test_dataservices_datamodel_planning_plan_dto.py +test/test_dataservices_datamodel_planning_plans_dto.py +test/test_dataservices_datamodel_population_configuration_dto.py +test/test_dataservices_datamodel_prediction_dto.py +test/test_dataservices_datamodel_predictions_dto.py +test/test_dataservices_datamodel_properties_dto.py +test/test_dataservices_datamodel_property_dto.py +test/test_dataservices_datamodel_property_reference_dto.py +test/test_dataservices_datamodel_scenario_or_snapshot_dto.py +test/test_dataservices_datamodel_selection_concept_dto.py +test/test_dataservices_datamodel_selection_concept_reference_dto.py +test/test_dataservices_datamodel_selection_concepts_dto.py +test/test_dataservices_datamodel_tag_map_element_dto.py +test/test_dataservices_datamodel_validity_range_dto.py +test/test_dataservices_query_aggregation_query_dto.py +test/test_dataservices_query_aggregation_query_execution_dto.py +test/test_dataservices_query_aggregation_query_source_dto.py +test/test_dataservices_query_aggregation_query_source_metric_dto.py +test/test_dataservices_query_aggregation_query_source_metrics_dto.py +test/test_dataservices_query_aggregation_type_parameter_value_dto.py +test/test_dataservices_query_cell_distribution_bin_dto.py +test/test_dataservices_query_cell_distribution_options_dto.py +test/test_dataservices_query_cell_dto.py +test/test_dataservices_query_cell_set_axis_dto.py +test/test_dataservices_query_cell_set_axis_position_dto.py +test/test_dataservices_query_cell_set_dto.py +test/test_dataservices_query_cell_set_or_error_dto.py +test/test_dataservices_query_cohort_filter_dto.py +test/test_dataservices_query_internal_query_execution_options_dto.py +test/test_dataservices_query_key_group_filter_dto.py +test/test_dataservices_query_key_group_filter_item_dto.py +test/test_dataservices_query_lineage_dto.py +test/test_dataservices_query_list_query_execution_dto.py +test/test_dataservices_query_list_query_execution_options_dto.py +test/test_dataservices_query_list_query_source_dto.py +test/test_dataservices_query_member_filter_dto.py +test/test_dataservices_query_member_parameter_value_dto.py +test/test_dataservices_query_numeric_parameter_value_dto.py +test/test_dataservices_query_plan_parameter_value_dto.py +test/test_dataservices_query_property_column_dto.py +test/test_dataservices_query_query_axis_dto.py +test/test_dataservices_query_query_axis_options_dto.py +test/test_dataservices_query_query_dimension_data_member_selection_dto.py +test/test_dataservices_query_query_dimension_leaf_selection_dto.py +test/test_dataservices_query_query_dimension_level_property_dto.py +test/test_dataservices_query_query_dimension_level_selection_dto.py +test/test_dataservices_query_query_dimension_member_selection_dto.py +test/test_dataservices_query_query_execution_error_details_dto.py +test/test_dataservices_query_query_execution_error_dto.py +test/test_dataservices_query_query_execution_errors_dto.py +test/test_dataservices_query_query_execution_options_dto.py +test/test_dataservices_query_query_filter_dto.py +test/test_dataservices_query_query_member_map_property_dto.py +test/test_dataservices_query_query_member_map_selection_dto.py +test/test_dataservices_query_query_numeric_ranges_dto.py +test/test_dataservices_query_query_parameter_value_dto.py +test/test_dataservices_query_query_property_dto.py +test/test_dataservices_query_query_time_interval_dto.py +test/test_dataservices_query_query_time_intervals_dto.py +test/test_dataservices_query_snapshot_query_execution_dto.py +test/test_dataservices_query_snapshot_query_execution_options_dto.py +test/test_dataservices_query_sort_option_dto.py +test/test_dataservices_query_sql_like_query_execution_dto.py +test/test_dataservices_query_time_shift_dto.py +test/test_description_entry.py +test/test_designer_adp_auth_params_dto.py +test/test_designer_api_analytic_object_filter_dto.py +test/test_designer_api_calculation_concept_configuration_dto.py +test/test_designer_api_calculation_concept_configuration_map_dto.py +test/test_designer_api_calculation_concept_dto.py +test/test_designer_api_calculation_concept_list_dto.py +test/test_designer_api_concept_configuration_result_dto.py +test/test_designer_api_dimension_filter_dto.py +test/test_designer_api_dimension_member_dto.py +test/test_designer_api_perspective_configuration_dto.py +test/test_designer_api_perspective_node_dto.py +test/test_designer_api_selection_concept_configuration_dto.py +test/test_designer_api_selection_concept_configuration_map_dto.py +test/test_designer_api_selection_concept_dto.py +test/test_designer_api_selection_concept_list_dto.py +test/test_designer_bamboo_auth_params_dto.py +test/test_designer_basic_s3_auth_params_dto.py +test/test_designer_big_query_auth_params_dto.py +test/test_designer_big_query_service_account_params_dto.py +test/test_designer_copy_s3_auth_params_dto.py +test/test_designer_credential_creation_api_response_dto.py +test/test_designer_crypto_generate_key_request_dto.py +test/test_designer_crypto_key_pair_delete_response_dto.py +test/test_designer_crypto_key_pair_generate_request_dto.py +test/test_designer_crypto_public_key_dto.py +test/test_designer_crypto_public_keys_dto.py +test/test_designer_crypto_tenant_encryption_key_details_dto.py +test/test_designer_crypto_tenant_encryption_key_dto.py +test/test_designer_data_provider_auth_information_dto.py +test/test_designer_data_provider_auth_params_dto.py +test/test_designer_data_provider_basic_information_dto.py +test/test_designer_data_provider_basic_metadata_dto.py +test/test_designer_data_version_export_column_dto.py +test/test_designer_data_version_export_data_version_summary_dto.py +test/test_designer_data_version_export_data_versions_dto.py +test/test_designer_data_version_export_dto.py +test/test_designer_data_version_export_file_dto.py +test/test_designer_data_version_export_job_status_dto.py +test/test_designer_data_version_export_part_file_dto.py +test/test_designer_data_version_export_schedule_job_request_dto.py +test/test_designer_data_version_export_schedule_job_response_dto.py +test/test_designer_data_version_export_table_dto.py +test/test_designer_data_version_exports_dto.py +test/test_designer_databricks_auth_params_dto.py +test/test_designer_dayforce_v2_auth_params_dto.py +test/test_designer_dimensions_auth_params_dto.py +test/test_designer_download_source_files_dto.py +test/test_designer_download_source_files_response_dto.py +test/test_designer_extractor_credential_apidto.py +test/test_designer_extractor_credentials_apidto.py +test/test_designer_fusion_auth_params_dto.py +test/test_designer_gong_auth_params_dto.py +test/test_designer_google_sheets_auth_params_dto.py +test/test_designer_google_workspace_auth_params_dto.py +test/test_designer_greenhouse_auth_params_dto.py +test/test_designer_icims_auth_params_dto.py +test/test_designer_internal_s3_auth_params_dto.py +test/test_designer_jdbc_auth_params_dto.py +test/test_designer_jira_auth_params_dto.py +test/test_designer_jira_connect_params_dto.py +test/test_designer_lever_auth_params_dto.py +test/test_designer_medallia_auth_params_dto.py +test/test_designer_microsoft365_auth_params_dto.py +test/test_designer_module_settings_dto.py +test/test_designer_my_sql_auth_params_dto.py +test/test_designer_namely_auth_params_dto.py +test/test_designer_oracle_db_auth_params_dto.py +test/test_designer_push_data_column_definition_dto.py +test/test_designer_push_data_source_definition_dto.py +test/test_designer_push_data_source_definitions_dto.py +test/test_designer_qualtrics_auth_params_dto.py +test/test_designer_redshift_auth_params_dto.py +test/test_designer_salesforce_auth_params_dto.py +test/test_designer_salesforce_v2_auth_params_dto.py +test/test_designer_service_now_auth_params_dto.py +test/test_designer_service_now_v2_auth_params_dto.py +test/test_designer_slack_auth_params_dto.py +test/test_designer_snowflake_auth_params_dto.py +test/test_designer_sql_server_auth_params_dto.py +test/test_designer_subject_missing_access_dto.py +test/test_designer_success_factors_auth_params_dto.py +test/test_designer_success_factors_o_auth_params_dto.py +test/test_designer_tenant_module_dto.py +test/test_designer_ultimate_auth_params_dto.py +test/test_designer_webhook_webhook_basic_auth_credential_dto.py +test/test_designer_webhook_webhook_credentials_dto.py +test/test_designer_webhook_webhook_details_dto.py +test/test_designer_webhook_webhook_dto.py +test/test_designer_webhook_webhook_event_type_dto.py +test/test_designer_webhook_webhook_message_response_dto.py +test/test_designer_webhook_webhook_request_dto.py +test/test_designer_webhook_webhooks_dto.py +test/test_designer_willow_auth_params_dto.py +test/test_designer_workday_auth_params_dto.py +test/test_designer_workday_o_auth_params_dto.py +test/test_designer_workday_raas_auth_params_dto.py +test/test_designer_workday_refresh_token_params_dto.py +test/test_designer_zoom_auth_params_dto.py +test/test_dimension_member.py +test/test_dimensions_api.py +test/test_direct_data_intake_api.py +test/test_direct_data_upload_file_response_dto.py +test/test_dp_automation_metric_validation_summary_dto.py +test/test_dp_automation_tenant_preview_entries_summary_dto.py +test/test_dp_automation_tenant_preview_entries_summary_list_dto.py +test/test_dp_cancel_job_batch_from_job_id_dto.py +test/test_dp_job_cancellation_result_dto.py +test/test_dp_job_cancellation_results_dto.py +test/test_dv_export_status.py +test/test_email_domains_api.py +test/test_encryption_keys_api.py +test/test_extracted_skill.py +test/test_generate_impersonation_token_request.py +test/test_google_protobuf_any.py +test/test_hierarchy.py +test/test_job.py +test/test_job_entry.py +test/test_job_feedback_input.py +test/test_job_search_failure_output.py +test/test_job_search_input.py +test/test_job_search_output.py +test/test_job_standardization_input.py +test/test_job_standardization_input_skills.py +test/test_jobs_library_api.py +test/test_location_search_failure_output.py +test/test_location_search_input.py +test/test_location_search_input1.py +test/test_location_search_output.py +test/test_location_search_successful_output.py +test/test_network_subnets_api.py +test/test_o_auth2_api.py +test/test_object_configuration_api.py +test/test_output_entry.py +test/test_output_entry1.py +test/test_output_entry1_matches_inner.py +test/test_permissions_api.py +test/test_pgp_key_api.py +test/test_plan_data_load_change_dto.py +test/test_plan_data_load_change_list_dto.py +test/test_plan_data_upload_response_dto.py +test/test_plan_row_data_load_response_dto.py +test/test_planning_data_load_api.py +test/test_planning_get_plan_list_response_dto.py +test/test_planning_plan_data_load_error_dto.py +test/test_planning_plan_info_dto.py +test/test_planning_plan_item_dto.py +test/test_planning_plan_schema_dto.py +test/test_planning_plan_segment_level_dto.py +test/test_planning_plan_segment_level_member_dto.py +test/test_planning_plan_segment_level_member_list_dto.py +test/test_planning_plan_time_period_dto.py +test/test_planning_plan_with_schema_dto.py +test/test_planning_scenario_info_dto.py +test/test_production_versions_api.py +test/test_profiles_api.py +test/test_projects_api.py +test/test_release_version_configuration_api.py +test/test_reporting_api.py +test/test_salary_benchmark_input.py +test/test_salary_benchmarks_batch_processing_failure_output.py +test/test_salary_benchmarks_batch_processing_outputs.py +test/test_salary_benchmarks_batch_processing_successful_output.py +test/test_search_api.py +test/test_servicing_accessible_tenant_profile_assignment_request_dto.py +test/test_servicing_accessible_tenant_profile_assignment_response_dto.py +test/test_servicing_accessible_tenant_profile_revoke_request_dto.py +test/test_servicing_accessible_tenant_profile_revoke_response_dto.py +test/test_servicing_additional_capabilities_dto.py +test/test_servicing_admin_capability_config_dto.py +test/test_servicing_all_permissions_assigned_for_local_tenant_dto.py +test/test_servicing_all_profile_assigned_for_accessible_tenant_dto.py +test/test_servicing_all_profile_assigned_for_local_tenant_dto.py +test/test_servicing_all_user_groups_assigned_for_local_tenant_dto.py +test/test_servicing_all_users_get_api_response_dto.py +test/test_servicing_analytic_object_dto.py +test/test_servicing_assign_revoke_permission_by_permission_dto.py +test/test_servicing_assign_revoke_permission_by_tenant_dto.py +test/test_servicing_assign_revoke_permission_by_user_dto.py +test/test_servicing_assign_revoke_permission_request_dto.py +test/test_servicing_assign_revoke_permissions_request_dto.py +test/test_servicing_assign_revoke_permissions_response_dto.py +test/test_servicing_bulk_data_access_set_response_dto.py +test/test_servicing_capabilities_dto.py +test/test_servicing_capability_dto.py +test/test_servicing_capability_group_dto.py +test/test_servicing_commit_and_publish_operation_response_dto.py +test/test_servicing_commit_dto.py +test/test_servicing_content_package_dto.py +test/test_servicing_create_data_access_set_request_dto.py +test/test_servicing_data_access_set_dto.py +test/test_servicing_data_access_set_error_dto.py +test/test_servicing_data_access_set_failure_dto.py +test/test_servicing_data_access_set_success_dto.py +test/test_servicing_data_categories_response_dto.py +test/test_servicing_data_category_response_dto.py +test/test_servicing_data_security_profile_dto.py +test/test_servicing_delete_permissions_request_dto.py +test/test_servicing_dimension_filter_dto.py +test/test_servicing_direct_data_job_config_dto.py +test/test_servicing_direct_data_job_status_response_dto.py +test/test_servicing_direct_data_list_transactions_response_dto.py +test/test_servicing_direct_data_load_config_dto.py +test/test_servicing_direct_data_schema_dto.py +test/test_servicing_direct_data_schema_field_dto.py +test/test_servicing_direct_data_transaction_dto.py +test/test_servicing_direct_data_transaction_start_response_dto.py +test/test_servicing_direct_data_upload_file_response_dto.py +test/test_servicing_document_search_link_dto.py +test/test_servicing_dynamic_dimension_filter_dto.py +test/test_servicing_dynamic_property_mapping_dto.py +test/test_servicing_error_dto.py +test/test_servicing_export_production_versions_api_operation_parameters_dto.py +test/test_servicing_failed_accessible_tenant_profile_assignment_dto.py +test/test_servicing_failed_local_tenant_profile_assignment_dto.py +test/test_servicing_failed_local_tenant_profile_revoke_dto.py +test/test_servicing_get_capabilities_api_response_dto.py +test/test_servicing_get_content_packages_api_response_dto.py +test/test_servicing_get_data_access_sets_api_response_dto.py +test/test_servicing_get_data_security_objects_api_response_dto.py +test/test_servicing_get_permissions_api_response_dto.py +test/test_servicing_get_production_versions_api_response_dto.py +test/test_servicing_get_projects_api_response_dto.py +test/test_servicing_hierarchy_property_dto.py +test/test_servicing_inherited_access_config_dto.py +test/test_servicing_inherited_reference_member_filter_config_dto.py +test/test_servicing_job_id_response.py +test/test_servicing_last_login_dto.py +test/test_servicing_local_tenant_profile_assignment_request_dto.py +test/test_servicing_local_tenant_profile_assignment_response_dto.py +test/test_servicing_local_tenant_profile_revoke_request_dto.py +test/test_servicing_local_tenant_profile_revoke_response_dto.py +test/test_servicing_member_filter_config_dto.py +test/test_servicing_member_selection_dto.py +test/test_servicing_objectconfiguration_calculated_property_type_dto.py +test/test_servicing_objectconfiguration_dependent_dto.py +test/test_servicing_objectconfiguration_dimension_change_definition_dto.py +test/test_servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto.py +test/test_servicing_objectconfiguration_dimensions_change_definitions_dto.py +test/test_servicing_objectconfiguration_object_change_failure_dto.py +test/test_servicing_objectconfiguration_object_change_success_dto.py +test/test_servicing_objectconfiguration_objects_bulk_change_response_dto.py +test/test_servicing_objectconfiguration_properties_change_definitions_dto.py +test/test_servicing_objectconfiguration_properties_delete_definitions_dto.py +test/test_servicing_objectconfiguration_property_bulk_delete_response_dto.py +test/test_servicing_objectconfiguration_property_change_definition_dto.py +test/test_servicing_objectconfiguration_property_change_definitions_by_tenant_dto.py +test/test_servicing_objectconfiguration_property_delete_definitions_by_tenant_dto.py +test/test_servicing_objectconfiguration_property_delete_failure_dto.py +test/test_servicing_objectconfiguration_property_delete_success_dto.py +test/test_servicing_objectconfiguration_property_type_dto.py +test/test_servicing_objectconfiguration_simple_property_type_dto.py +test/test_servicing_objectconfiguration_tags_dto.py +test/test_servicing_permission_assigned_by_tenant_dto.py +test/test_servicing_permission_assigned_for_local_tenant_dto.py +test/test_servicing_permission_assigned_user_dto.py +test/test_servicing_permission_assigned_users_dto.py +test/test_servicing_permission_bulk_operation_response_dto.py +test/test_servicing_permission_dto.py +test/test_servicing_permission_error_dto.py +test/test_servicing_permission_failure_dto.py +test/test_servicing_permission_success_dto.py +test/test_servicing_production_version_api_operation_request_dto.py +test/test_servicing_production_version_api_operation_response_dto.py +test/test_servicing_production_versions_api_operation_request_dto.py +test/test_servicing_production_versions_api_operation_response_dto.py +test/test_servicing_profile_assigned_for_accessible_tenant_dto.py +test/test_servicing_profile_assigned_for_local_tenant_dto.py +test/test_servicing_profile_get_api_response_dto.py +test/test_servicing_profiles_get_api_response_dto.py +test/test_servicing_project_commits_api_response_dto.py +test/test_servicing_project_dto.py +test/test_servicing_project_operation_request_dto.py +test/test_servicing_project_operation_response_dto.py +test/test_servicing_property_access_config_dto.py +test/test_servicing_property_set_config_dto.py +test/test_servicing_question_categories_api_response_dto.py +test/test_servicing_question_category_api_response_dto.py +test/test_servicing_reduced_error_dto.py +test/test_servicing_reduced_tenant_code_error_dto.py +test/test_servicing_reduced_user_id_error_dto.py +test/test_servicing_related_analytic_object_dto.py +test/test_servicing_role_modules_config_dto.py +test/test_servicing_sample_question_api_response_dto.py +test/test_servicing_sample_questions_api_response_dto.py +test/test_servicing_securable_dimension_dto.py +test/test_servicing_securable_property_dto.py +test/test_servicing_servicing_capability_proto_enum_access_lookup_dto.py +test/test_servicing_shareable_data_access_set.py +test/test_servicing_simple_document_header_search_response_dto.py +test/test_servicing_simple_document_header_search_result_dto.py +test/test_servicing_sources_api_operation_request_dto.py +test/test_servicing_static_dimension_filter_dto.py +test/test_servicing_successful_accessible_tenant_profile_assignment_dto.py +test/test_servicing_successful_local_tenant_profile_assignment_dto.py +test/test_servicing_target_tenant_code_dto.py +test/test_servicing_tenant_code_error_dto.py +test/test_servicing_tenant_data_upload_status_response_dto.py +test/test_servicing_tenant_data_upload_update_status_response_dto.py +test/test_servicing_tenant_data_uploads_list_response_dto.py +test/test_servicing_tenant_data_uploads_response_dto.py +test/test_servicing_tenant_data_uploads_update_response_dto.py +test/test_servicing_user_creation_api_request_dto.py +test/test_servicing_user_get_api_response_dto.py +test/test_servicing_user_group_assigned_for_local_tenant_dto.py +test/test_servicing_user_group_assignment_dto.py +test/test_servicing_user_id_error_dto.py +test/test_servicing_user_property_dto.py +test/test_servicing_user_update_api_request_dto.py +test/test_servicing_users_api_error_message_dto.py +test/test_servicing_users_api_failure_dto.py +test/test_servicing_users_api_response_dto.py +test/test_servicing_users_api_success_dto.py +test/test_servicing_users_creation_api_request_dto.py +test/test_servicing_users_delete_api_request_dto.py +test/test_servicing_users_update_api_request_dto.py +test/test_servicing_users_update_api_user_dto.py +test/test_servicing_v2_objectconfiguration_analytic_object_definition_dto.py +test/test_servicing_v2_objectconfiguration_analytic_object_request_dto.py +test/test_servicing_v2_objectconfiguration_analytic_object_with_context_dto.py +test/test_servicing_v2_objectconfiguration_basic_information_dto.py +test/test_servicing_v2_objectconfiguration_bulk_change_response_dto.py +test/test_servicing_v2_objectconfiguration_calculated_property_type_dto.py +test/test_servicing_v2_objectconfiguration_concept_definition_dto.py +test/test_servicing_v2_objectconfiguration_concept_delete_request_dto.py +test/test_servicing_v2_objectconfiguration_concept_delete_with_context_dto.py +test/test_servicing_v2_objectconfiguration_concept_request_dto.py +test/test_servicing_v2_objectconfiguration_concept_response_dto.py +test/test_servicing_v2_objectconfiguration_concept_type_details_dto.py +test/test_servicing_v2_objectconfiguration_concept_with_context_dto.py +test/test_servicing_v2_objectconfiguration_execution_context_dto.py +test/test_servicing_v2_objectconfiguration_failed_change_dto.py +test/test_servicing_v2_objectconfiguration_metric_definition_dto.py +test/test_servicing_v2_objectconfiguration_metric_type_details_dto.py +test/test_servicing_v2_objectconfiguration_object_id_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_definition_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_member_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_member_list_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_metric_definition_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_metric_list_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_outcome_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_outcome_list_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_property_list_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_property_type_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_stage_dto.py +test/test_servicing_v2_objectconfiguration_process_concept_stage_list_dto.py +test/test_servicing_v2_objectconfiguration_property_definition_dto.py +test/test_servicing_v2_objectconfiguration_property_type_details_dto.py +test/test_servicing_v2_objectconfiguration_simple_property_type_dto.py +test/test_servicing_v2_objectconfiguration_successful_change_dto.py +test/test_servicing_v2_objectconfiguration_synonym_list_dto.py +test/test_servicing_v2_objectconfiguration_tag_reference_dto.py +test/test_servicing_v2_objectconfiguration_tag_reference_list_dto.py +test/test_servicing_vee_question_change_definition_dto.py +test/test_servicing_vee_question_change_definitions_by_tenant_dto.py +test/test_servicing_vee_question_change_failure_dto.py +test/test_servicing_vee_question_change_success_dto.py +test/test_servicing_vee_question_delete_definitions_by_tenant_dto.py +test/test_servicing_vee_questions_bulk_change_response_dto.py +test/test_servicing_vee_questions_change_definitions_dto.py +test/test_servicing_vee_questions_delete_definitions_dto.py +test/test_skill.py +test/test_skill_category.py +test/test_skill_category_entry.py +test/test_skill_entry.py +test/test_skill_extraction_input.py +test/test_skill_group.py +test/test_skill_group_entry.py +test/test_skill_match_input.py +test/test_skills_library_api.py +test/test_source_files_download_api.py +test/test_source_import_result_summary_dto.py +test/test_sources_api.py +test/test_sources_api_put_response_dto.py +test/test_status.py +test/test_system_status_api.py +test/test_systemstatus_system_status_dto.py +test/test_systemstatus_vee_status_dto.py +test/test_table_response_dto.py +test/test_tenants_v1_api.py +test/test_tenants_v2_api.py +test/test_token_response.py +test/test_user_creation_api_response_dto.py +test/test_user_groups_v2_api.py +test/test_users_v1_api.py +test/test_users_v2_api.py +test/test_vee_api.py +test/test_webhooks_api.py +tox.ini +visier_platform_sdk/__init__.py +visier_platform_sdk/api/__init__.py +visier_platform_sdk/api/basic_authentication_api.py +visier_platform_sdk/api/benchmarks_api.py +visier_platform_sdk/api/concepts_v2_api.py +visier_platform_sdk/api/consolidated_analytics_api.py +visier_platform_sdk/api/data_and_job_handling_api.py +visier_platform_sdk/api/data_intake_api.py +visier_platform_sdk/api/data_model_api.py +visier_platform_sdk/api/data_query_api.py +visier_platform_sdk/api/data_upload_api.py +visier_platform_sdk/api/data_version_export_api.py +visier_platform_sdk/api/dimensions_api.py +visier_platform_sdk/api/direct_data_intake_api.py +visier_platform_sdk/api/email_domains_api.py +visier_platform_sdk/api/encryption_keys_api.py +visier_platform_sdk/api/jobs_library_api.py +visier_platform_sdk/api/network_subnets_api.py +visier_platform_sdk/api/o_auth2_api.py +visier_platform_sdk/api/object_configuration_api.py +visier_platform_sdk/api/permissions_api.py +visier_platform_sdk/api/pgp_key_api.py +visier_platform_sdk/api/planning_data_load_api.py +visier_platform_sdk/api/production_versions_api.py +visier_platform_sdk/api/profiles_api.py +visier_platform_sdk/api/projects_api.py +visier_platform_sdk/api/release_version_configuration_api.py +visier_platform_sdk/api/reporting_api.py +visier_platform_sdk/api/search_api.py +visier_platform_sdk/api/skills_library_api.py +visier_platform_sdk/api/source_files_download_api.py +visier_platform_sdk/api/sources_api.py +visier_platform_sdk/api/system_status_api.py +visier_platform_sdk/api/tenants_v1_api.py +visier_platform_sdk/api/tenants_v2_api.py +visier_platform_sdk/api/user_groups_v2_api.py +visier_platform_sdk/api/users_v1_api.py +visier_platform_sdk/api/users_v2_api.py +visier_platform_sdk/api/vee_api.py +visier_platform_sdk/api/webhooks_api.py +visier_platform_sdk/api_client.py +visier_platform_sdk/api_response.py +visier_platform_sdk/configuration.py +visier_platform_sdk/exceptions.py +visier_platform_sdk/models/__init__.py +visier_platform_sdk/models/admin_all_tenants_status_apidto.py +visier_platform_sdk/models/admin_assign_connector_credentials_by_tenant_response_dto.py +visier_platform_sdk/models/admin_assign_connector_credentials_response_dto.py +visier_platform_sdk/models/admin_assign_connector_with_credentials_response_dto.py +visier_platform_sdk/models/admin_assigned_credential_info_response_dto.py +visier_platform_sdk/models/admin_batch_tenant_provision_apidto.py +visier_platform_sdk/models/admin_business_location_dto.py +visier_platform_sdk/models/admin_connector_info_response_dto.py +visier_platform_sdk/models/admin_connector_setting_request_dto.py +visier_platform_sdk/models/admin_connector_setting_response_dto.py +visier_platform_sdk/models/admin_connector_settings_response_dto.py +visier_platform_sdk/models/admin_consolidated_analytics_api_excluded_source_list_dto.py +visier_platform_sdk/models/admin_consolidated_analytics_api_source_tenant_list_dto.py +visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_create_request_dto.py +visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_list_response_dto.py +visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details.py +visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details_list_response_dto.py +visier_platform_sdk/models/admin_custom_property_dto.py +visier_platform_sdk/models/admin_custom_tenant_property_dto.py +visier_platform_sdk/models/admin_data_import_definition_apidto.py +visier_platform_sdk/models/admin_data_import_definitions_apidto.py +visier_platform_sdk/models/admin_data_version_and_date_dto.py +visier_platform_sdk/models/admin_delete_user_group_v2_request.py +visier_platform_sdk/models/admin_element_ids_dto.py +visier_platform_sdk/models/admin_email_domains_dto.py +visier_platform_sdk/models/admin_excluded_sources_body.py +visier_platform_sdk/models/admin_extractor_setting_apidto.py +visier_platform_sdk/models/admin_extractor_setting_key_value_apidto.py +visier_platform_sdk/models/admin_extractor_settings_apidto.py +visier_platform_sdk/models/admin_home_analysis_by_user_group_dto.py +visier_platform_sdk/models/admin_jobs_consolidated_analytics_job_request_dto.py +visier_platform_sdk/models/admin_jobs_extract_data_and_load_dto.py +visier_platform_sdk/models/admin_jobs_processing_job_request_dto.py +visier_platform_sdk/models/admin_key_name.py +visier_platform_sdk/models/admin_mask_message.py +visier_platform_sdk/models/admin_multiple_tenant_data_versions_details_dto.py +visier_platform_sdk/models/admin_multiple_tenant_data_versions_list_dto.py +visier_platform_sdk/models/admin_network_subnets_message_request.py +visier_platform_sdk/models/admin_network_subnets_message_response.py +visier_platform_sdk/models/admin_permission_response_dto.py +visier_platform_sdk/models/admin_permissions_list_dto.py +visier_platform_sdk/models/admin_permissions_to_user_group_for_tenant_dto.py +visier_platform_sdk/models/admin_permissions_to_user_group_request_dto.py +visier_platform_sdk/models/admin_permissions_to_user_groups_request_dto.py +visier_platform_sdk/models/admin_product_release_dto.py +visier_platform_sdk/models/admin_product_releases_dto.py +visier_platform_sdk/models/admin_product_version_dto.py +visier_platform_sdk/models/admin_product_versions_dto.py +visier_platform_sdk/models/admin_product_versions_update_failure_tenant_response_dto.py +visier_platform_sdk/models/admin_product_versions_update_response_dto.py +visier_platform_sdk/models/admin_product_versions_update_successful_tenant_response_dto.py +visier_platform_sdk/models/admin_put_project_commits_request.py +visier_platform_sdk/models/admin_security_assignment_response_dto.py +visier_platform_sdk/models/admin_set_connector_setting_request_dto.py +visier_platform_sdk/models/admin_set_connector_setting_response_dto.py +visier_platform_sdk/models/admin_set_connector_settings_request_dto.py +visier_platform_sdk/models/admin_set_connector_settings_response_dto.py +visier_platform_sdk/models/admin_simple_user_dto.py +visier_platform_sdk/models/admin_target_project_for_tenant_dto.py +visier_platform_sdk/models/admin_target_project_for_tenants_list_dto.py +visier_platform_sdk/models/admin_tenant_assignments_dto.py +visier_platform_sdk/models/admin_tenant_code_body.py +visier_platform_sdk/models/admin_tenant_connector_settings_request_dto.py +visier_platform_sdk/models/admin_tenant_detail_apidto.py +visier_platform_sdk/models/admin_tenant_details_traits_dto.py +visier_platform_sdk/models/admin_tenant_management_api_get_response_dto.py +visier_platform_sdk/models/admin_tenant_management_api_list_response_dto.py +visier_platform_sdk/models/admin_tenant_management_api_update_request_dto.py +visier_platform_sdk/models/admin_tenant_management_api_update_response_dto.py +visier_platform_sdk/models/admin_tenant_provision_apidto.py +visier_platform_sdk/models/admin_tenant_status_apidto.py +visier_platform_sdk/models/admin_update_tenant_model.py +visier_platform_sdk/models/admin_user_group_change_definition_dto.py +visier_platform_sdk/models/admin_user_group_change_dimension_filter_dto.py +visier_platform_sdk/models/admin_user_group_change_failure_dto.py +visier_platform_sdk/models/admin_user_group_change_filter_dto.py +visier_platform_sdk/models/admin_user_group_change_member_selection_dto.py +visier_platform_sdk/models/admin_user_group_change_response_dto.py +visier_platform_sdk/models/admin_user_group_change_success_dto.py +visier_platform_sdk/models/admin_user_group_change_users_dto.py +visier_platform_sdk/models/admin_user_group_delete_dto.py +visier_platform_sdk/models/admin_user_group_delete_failure_dto.py +visier_platform_sdk/models/admin_user_group_delete_response_dto.py +visier_platform_sdk/models/admin_user_group_delete_success_dto.py +visier_platform_sdk/models/admin_user_group_filters_dto.py +visier_platform_sdk/models/admin_user_group_get_api_response_dto.py +visier_platform_sdk/models/admin_user_group_single_delete_response_dto.py +visier_platform_sdk/models/admin_user_groups_change_dto.py +visier_platform_sdk/models/admin_user_groups_delete_request_dto.py +visier_platform_sdk/models/admin_user_groups_get_api_response_dto.py +visier_platform_sdk/models/admin_user_groups_users_dto.py +visier_platform_sdk/models/admin_user_groups_users_for_tenant_dto.py +visier_platform_sdk/models/admin_user_security_assignments_dto.py +visier_platform_sdk/models/admin_users_to_user_group_request_dto.py +visier_platform_sdk/models/admin_users_to_user_groups_request_dto.py +visier_platform_sdk/models/analysis_common_report_create_request_dto.py +visier_platform_sdk/models/analysis_common_report_delete_success_dto.py +visier_platform_sdk/models/analysis_common_report_dto.py +visier_platform_sdk/models/analysis_common_report_list_response_dto.py +visier_platform_sdk/models/analysis_common_vee_clarification_dto.py +visier_platform_sdk/models/analysis_common_vee_conversation_state_dto.py +visier_platform_sdk/models/analysis_common_vee_corrections_dto.py +visier_platform_sdk/models/analysis_common_vee_data_dto.py +visier_platform_sdk/models/analysis_common_vee_feedback_dto.py +visier_platform_sdk/models/analysis_common_vee_options_dto.py +visier_platform_sdk/models/analysis_common_vee_question_dto.py +visier_platform_sdk/models/analysis_common_vee_response_dto.py +visier_platform_sdk/models/analysis_common_vee_response_schema_dto.py +visier_platform_sdk/models/analysis_common_vee_response_schema_reference_dto.py +visier_platform_sdk/models/analysis_common_vee_sample_question_dto.py +visier_platform_sdk/models/analysis_common_vee_sample_question_library_dto.py +visier_platform_sdk/models/analysis_common_vee_status_code_dto.py +visier_platform_sdk/models/analysis_common_vee_visual_dto.py +visier_platform_sdk/models/analysis_common_vee_visual_options_dto.py +visier_platform_sdk/models/api_error.py +visier_platform_sdk/models/authentication_o_auth2_user_info_dto.py +visier_platform_sdk/models/authentication_o_auth2_user_subnet_info_dto.py +visier_platform_sdk/models/authentication_o_auth2_user_tenant_detail_dto.py +visier_platform_sdk/models/authentication_o_auth2_user_tenant_details_dto.py +visier_platform_sdk/models/authentication_o_auth2_user_tenant_properties_dto.py +visier_platform_sdk/models/benchmark_info.py +visier_platform_sdk/models/benchmark_value.py +visier_platform_sdk/models/data_in_assign_connector_credential_request.py +visier_platform_sdk/models/data_in_connector.py +visier_platform_sdk/models/data_in_data_load_request.py +visier_platform_sdk/models/data_in_data_load_request_model.py +visier_platform_sdk/models/data_in_data_load_response.py +visier_platform_sdk/models/data_in_data_transfer_result_detail.py +visier_platform_sdk/models/data_in_data_version_object.py +visier_platform_sdk/models/data_in_disable_dv_model.py +visier_platform_sdk/models/data_in_disable_dv_request.py +visier_platform_sdk/models/data_in_disable_dv_response.py +visier_platform_sdk/models/data_in_dispatching_job_status_response.py +visier_platform_sdk/models/data_in_exclude_data_uploads_request.py +visier_platform_sdk/models/data_in_extraction_job.py +visier_platform_sdk/models/data_in_extraction_job_and_status_response.py +visier_platform_sdk/models/data_in_include_data_uploads_request.py +visier_platform_sdk/models/data_in_job_status_list_response.py +visier_platform_sdk/models/data_in_job_status_with_start_time.py +visier_platform_sdk/models/data_in_processing_job.py +visier_platform_sdk/models/data_in_processing_job_and_status_response.py +visier_platform_sdk/models/data_in_processing_job_status_response.py +visier_platform_sdk/models/data_in_push_data_cancel_response.py +visier_platform_sdk/models/data_in_push_data_complete_request.py +visier_platform_sdk/models/data_in_push_data_complete_response.py +visier_platform_sdk/models/data_in_push_data_response.py +visier_platform_sdk/models/data_in_receiving_job.py +visier_platform_sdk/models/data_in_receiving_job_and_status_response.py +visier_platform_sdk/models/data_in_receiving_job_status_response.py +visier_platform_sdk/models/data_in_result.py +visier_platform_sdk/models/data_in_source.py +visier_platform_sdk/models/data_in_start_extraction_response.py +visier_platform_sdk/models/data_in_start_transfer_response.py +visier_platform_sdk/models/data_in_tenant.py +visier_platform_sdk/models/data_in_tenant_and_credential.py +visier_platform_sdk/models/data_in_upload_to_exclude.py +visier_platform_sdk/models/data_in_upload_to_include.py +visier_platform_sdk/models/data_out_list_response.py +visier_platform_sdk/models/dataservices_common_dimension_member_reference_dto.py +visier_platform_sdk/models/dataservices_common_member_values_dto.py +visier_platform_sdk/models/dataservices_datamodel_aggregation_type_option_dto.py +visier_platform_sdk/models/dataservices_datamodel_aggregation_type_parameter_dto.py +visier_platform_sdk/models/dataservices_datamodel_analytic_object_dto.py +visier_platform_sdk/models/dataservices_datamodel_analytic_objects_dto.py +visier_platform_sdk/models/dataservices_datamodel_currencies_dto.py +visier_platform_sdk/models/dataservices_datamodel_currency_dto.py +visier_platform_sdk/models/dataservices_datamodel_currency_rate_dto.py +visier_platform_sdk/models/dataservices_datamodel_currency_rates_dto.py +visier_platform_sdk/models/dataservices_datamodel_dimension_dto.py +visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_dto.py +visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_execution_dto.py +visier_platform_sdk/models/dataservices_datamodel_dimension_reference_dto.py +visier_platform_sdk/models/dataservices_datamodel_dimensions_dto.py +visier_platform_sdk/models/dataservices_datamodel_level_dto.py +visier_platform_sdk/models/dataservices_datamodel_member_dto.py +visier_platform_sdk/models/dataservices_datamodel_member_parameter_definition_dto.py +visier_platform_sdk/models/dataservices_datamodel_members_dto.py +visier_platform_sdk/models/dataservices_datamodel_metric_dto.py +visier_platform_sdk/models/dataservices_datamodel_metrics_dto.py +visier_platform_sdk/models/dataservices_datamodel_numeric_parameter_definition_dto.py +visier_platform_sdk/models/dataservices_datamodel_object_reference_dto.py +visier_platform_sdk/models/dataservices_datamodel_parameter_definition_dto.py +visier_platform_sdk/models/dataservices_datamodel_plan_parameter_definition_dto.py +visier_platform_sdk/models/dataservices_datamodel_planning_concept_filter_context_dto.py +visier_platform_sdk/models/dataservices_datamodel_planning_hierarchy_filter_context_dto.py +visier_platform_sdk/models/dataservices_datamodel_planning_model_dto.py +visier_platform_sdk/models/dataservices_datamodel_planning_models_dto.py +visier_platform_sdk/models/dataservices_datamodel_planning_plan_context_dto.py +visier_platform_sdk/models/dataservices_datamodel_planning_plan_dto.py +visier_platform_sdk/models/dataservices_datamodel_planning_plans_dto.py +visier_platform_sdk/models/dataservices_datamodel_population_configuration_dto.py +visier_platform_sdk/models/dataservices_datamodel_prediction_dto.py +visier_platform_sdk/models/dataservices_datamodel_predictions_dto.py +visier_platform_sdk/models/dataservices_datamodel_properties_dto.py +visier_platform_sdk/models/dataservices_datamodel_property_dto.py +visier_platform_sdk/models/dataservices_datamodel_property_reference_dto.py +visier_platform_sdk/models/dataservices_datamodel_scenario_or_snapshot_dto.py +visier_platform_sdk/models/dataservices_datamodel_selection_concept_dto.py +visier_platform_sdk/models/dataservices_datamodel_selection_concept_reference_dto.py +visier_platform_sdk/models/dataservices_datamodel_selection_concepts_dto.py +visier_platform_sdk/models/dataservices_datamodel_tag_map_element_dto.py +visier_platform_sdk/models/dataservices_datamodel_validity_range_dto.py +visier_platform_sdk/models/dataservices_query_aggregation_query_dto.py +visier_platform_sdk/models/dataservices_query_aggregation_query_execution_dto.py +visier_platform_sdk/models/dataservices_query_aggregation_query_source_dto.py +visier_platform_sdk/models/dataservices_query_aggregation_query_source_metric_dto.py +visier_platform_sdk/models/dataservices_query_aggregation_query_source_metrics_dto.py +visier_platform_sdk/models/dataservices_query_aggregation_type_parameter_value_dto.py +visier_platform_sdk/models/dataservices_query_cell_distribution_bin_dto.py +visier_platform_sdk/models/dataservices_query_cell_distribution_options_dto.py +visier_platform_sdk/models/dataservices_query_cell_dto.py +visier_platform_sdk/models/dataservices_query_cell_set_axis_dto.py +visier_platform_sdk/models/dataservices_query_cell_set_axis_position_dto.py +visier_platform_sdk/models/dataservices_query_cell_set_dto.py +visier_platform_sdk/models/dataservices_query_cell_set_or_error_dto.py +visier_platform_sdk/models/dataservices_query_cohort_filter_dto.py +visier_platform_sdk/models/dataservices_query_internal_query_execution_options_dto.py +visier_platform_sdk/models/dataservices_query_key_group_filter_dto.py +visier_platform_sdk/models/dataservices_query_key_group_filter_item_dto.py +visier_platform_sdk/models/dataservices_query_lineage_dto.py +visier_platform_sdk/models/dataservices_query_list_query_execution_dto.py +visier_platform_sdk/models/dataservices_query_list_query_execution_options_dto.py +visier_platform_sdk/models/dataservices_query_list_query_source_dto.py +visier_platform_sdk/models/dataservices_query_member_filter_dto.py +visier_platform_sdk/models/dataservices_query_member_parameter_value_dto.py +visier_platform_sdk/models/dataservices_query_numeric_parameter_value_dto.py +visier_platform_sdk/models/dataservices_query_plan_parameter_value_dto.py +visier_platform_sdk/models/dataservices_query_property_column_dto.py +visier_platform_sdk/models/dataservices_query_query_axis_dto.py +visier_platform_sdk/models/dataservices_query_query_axis_options_dto.py +visier_platform_sdk/models/dataservices_query_query_dimension_data_member_selection_dto.py +visier_platform_sdk/models/dataservices_query_query_dimension_leaf_selection_dto.py +visier_platform_sdk/models/dataservices_query_query_dimension_level_property_dto.py +visier_platform_sdk/models/dataservices_query_query_dimension_level_selection_dto.py +visier_platform_sdk/models/dataservices_query_query_dimension_member_selection_dto.py +visier_platform_sdk/models/dataservices_query_query_execution_error_details_dto.py +visier_platform_sdk/models/dataservices_query_query_execution_error_dto.py +visier_platform_sdk/models/dataservices_query_query_execution_errors_dto.py +visier_platform_sdk/models/dataservices_query_query_execution_options_dto.py +visier_platform_sdk/models/dataservices_query_query_filter_dto.py +visier_platform_sdk/models/dataservices_query_query_member_map_property_dto.py +visier_platform_sdk/models/dataservices_query_query_member_map_selection_dto.py +visier_platform_sdk/models/dataservices_query_query_numeric_ranges_dto.py +visier_platform_sdk/models/dataservices_query_query_parameter_value_dto.py +visier_platform_sdk/models/dataservices_query_query_property_dto.py +visier_platform_sdk/models/dataservices_query_query_time_interval_dto.py +visier_platform_sdk/models/dataservices_query_query_time_intervals_dto.py +visier_platform_sdk/models/dataservices_query_snapshot_query_execution_dto.py +visier_platform_sdk/models/dataservices_query_snapshot_query_execution_options_dto.py +visier_platform_sdk/models/dataservices_query_sort_option_dto.py +visier_platform_sdk/models/dataservices_query_sql_like_query_execution_dto.py +visier_platform_sdk/models/dataservices_query_time_shift_dto.py +visier_platform_sdk/models/description_entry.py +visier_platform_sdk/models/designer_adp_auth_params_dto.py +visier_platform_sdk/models/designer_api_analytic_object_filter_dto.py +visier_platform_sdk/models/designer_api_calculation_concept_configuration_dto.py +visier_platform_sdk/models/designer_api_calculation_concept_configuration_map_dto.py +visier_platform_sdk/models/designer_api_calculation_concept_dto.py +visier_platform_sdk/models/designer_api_calculation_concept_list_dto.py +visier_platform_sdk/models/designer_api_concept_configuration_result_dto.py +visier_platform_sdk/models/designer_api_dimension_filter_dto.py +visier_platform_sdk/models/designer_api_dimension_member_dto.py +visier_platform_sdk/models/designer_api_perspective_configuration_dto.py +visier_platform_sdk/models/designer_api_perspective_node_dto.py +visier_platform_sdk/models/designer_api_selection_concept_configuration_dto.py +visier_platform_sdk/models/designer_api_selection_concept_configuration_map_dto.py +visier_platform_sdk/models/designer_api_selection_concept_dto.py +visier_platform_sdk/models/designer_api_selection_concept_list_dto.py +visier_platform_sdk/models/designer_bamboo_auth_params_dto.py +visier_platform_sdk/models/designer_basic_s3_auth_params_dto.py +visier_platform_sdk/models/designer_big_query_auth_params_dto.py +visier_platform_sdk/models/designer_big_query_service_account_params_dto.py +visier_platform_sdk/models/designer_copy_s3_auth_params_dto.py +visier_platform_sdk/models/designer_credential_creation_api_response_dto.py +visier_platform_sdk/models/designer_crypto_generate_key_request_dto.py +visier_platform_sdk/models/designer_crypto_key_pair_delete_response_dto.py +visier_platform_sdk/models/designer_crypto_key_pair_generate_request_dto.py +visier_platform_sdk/models/designer_crypto_public_key_dto.py +visier_platform_sdk/models/designer_crypto_public_keys_dto.py +visier_platform_sdk/models/designer_crypto_tenant_encryption_key_details_dto.py +visier_platform_sdk/models/designer_crypto_tenant_encryption_key_dto.py +visier_platform_sdk/models/designer_data_provider_auth_information_dto.py +visier_platform_sdk/models/designer_data_provider_auth_params_dto.py +visier_platform_sdk/models/designer_data_provider_basic_information_dto.py +visier_platform_sdk/models/designer_data_provider_basic_metadata_dto.py +visier_platform_sdk/models/designer_data_version_export_column_dto.py +visier_platform_sdk/models/designer_data_version_export_data_version_summary_dto.py +visier_platform_sdk/models/designer_data_version_export_data_versions_dto.py +visier_platform_sdk/models/designer_data_version_export_dto.py +visier_platform_sdk/models/designer_data_version_export_file_dto.py +visier_platform_sdk/models/designer_data_version_export_job_status_dto.py +visier_platform_sdk/models/designer_data_version_export_part_file_dto.py +visier_platform_sdk/models/designer_data_version_export_schedule_job_request_dto.py +visier_platform_sdk/models/designer_data_version_export_schedule_job_response_dto.py +visier_platform_sdk/models/designer_data_version_export_table_dto.py +visier_platform_sdk/models/designer_data_version_exports_dto.py +visier_platform_sdk/models/designer_databricks_auth_params_dto.py +visier_platform_sdk/models/designer_dayforce_v2_auth_params_dto.py +visier_platform_sdk/models/designer_dimensions_auth_params_dto.py +visier_platform_sdk/models/designer_download_source_files_dto.py +visier_platform_sdk/models/designer_download_source_files_response_dto.py +visier_platform_sdk/models/designer_extractor_credential_apidto.py +visier_platform_sdk/models/designer_extractor_credentials_apidto.py +visier_platform_sdk/models/designer_fusion_auth_params_dto.py +visier_platform_sdk/models/designer_gong_auth_params_dto.py +visier_platform_sdk/models/designer_google_sheets_auth_params_dto.py +visier_platform_sdk/models/designer_google_workspace_auth_params_dto.py +visier_platform_sdk/models/designer_greenhouse_auth_params_dto.py +visier_platform_sdk/models/designer_icims_auth_params_dto.py +visier_platform_sdk/models/designer_internal_s3_auth_params_dto.py +visier_platform_sdk/models/designer_jdbc_auth_params_dto.py +visier_platform_sdk/models/designer_jira_auth_params_dto.py +visier_platform_sdk/models/designer_jira_connect_params_dto.py +visier_platform_sdk/models/designer_lever_auth_params_dto.py +visier_platform_sdk/models/designer_medallia_auth_params_dto.py +visier_platform_sdk/models/designer_microsoft365_auth_params_dto.py +visier_platform_sdk/models/designer_module_settings_dto.py +visier_platform_sdk/models/designer_my_sql_auth_params_dto.py +visier_platform_sdk/models/designer_namely_auth_params_dto.py +visier_platform_sdk/models/designer_oracle_db_auth_params_dto.py +visier_platform_sdk/models/designer_push_data_column_definition_dto.py +visier_platform_sdk/models/designer_push_data_source_definition_dto.py +visier_platform_sdk/models/designer_push_data_source_definitions_dto.py +visier_platform_sdk/models/designer_qualtrics_auth_params_dto.py +visier_platform_sdk/models/designer_redshift_auth_params_dto.py +visier_platform_sdk/models/designer_salesforce_auth_params_dto.py +visier_platform_sdk/models/designer_salesforce_v2_auth_params_dto.py +visier_platform_sdk/models/designer_service_now_auth_params_dto.py +visier_platform_sdk/models/designer_service_now_v2_auth_params_dto.py +visier_platform_sdk/models/designer_slack_auth_params_dto.py +visier_platform_sdk/models/designer_snowflake_auth_params_dto.py +visier_platform_sdk/models/designer_sql_server_auth_params_dto.py +visier_platform_sdk/models/designer_subject_missing_access_dto.py +visier_platform_sdk/models/designer_success_factors_auth_params_dto.py +visier_platform_sdk/models/designer_success_factors_o_auth_params_dto.py +visier_platform_sdk/models/designer_tenant_module_dto.py +visier_platform_sdk/models/designer_ultimate_auth_params_dto.py +visier_platform_sdk/models/designer_webhook_webhook_basic_auth_credential_dto.py +visier_platform_sdk/models/designer_webhook_webhook_credentials_dto.py +visier_platform_sdk/models/designer_webhook_webhook_details_dto.py +visier_platform_sdk/models/designer_webhook_webhook_dto.py +visier_platform_sdk/models/designer_webhook_webhook_event_type_dto.py +visier_platform_sdk/models/designer_webhook_webhook_message_response_dto.py +visier_platform_sdk/models/designer_webhook_webhook_request_dto.py +visier_platform_sdk/models/designer_webhook_webhooks_dto.py +visier_platform_sdk/models/designer_willow_auth_params_dto.py +visier_platform_sdk/models/designer_workday_auth_params_dto.py +visier_platform_sdk/models/designer_workday_o_auth_params_dto.py +visier_platform_sdk/models/designer_workday_raas_auth_params_dto.py +visier_platform_sdk/models/designer_workday_refresh_token_params_dto.py +visier_platform_sdk/models/designer_zoom_auth_params_dto.py +visier_platform_sdk/models/dimension_member.py +visier_platform_sdk/models/direct_data_upload_file_response_dto.py +visier_platform_sdk/models/dp_automation_metric_validation_summary_dto.py +visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_dto.py +visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_list_dto.py +visier_platform_sdk/models/dp_cancel_job_batch_from_job_id_dto.py +visier_platform_sdk/models/dp_job_cancellation_result_dto.py +visier_platform_sdk/models/dp_job_cancellation_results_dto.py +visier_platform_sdk/models/dv_export_status.py +visier_platform_sdk/models/extracted_skill.py +visier_platform_sdk/models/generate_impersonation_token_request.py +visier_platform_sdk/models/google_protobuf_any.py +visier_platform_sdk/models/hierarchy.py +visier_platform_sdk/models/job.py +visier_platform_sdk/models/job_entry.py +visier_platform_sdk/models/job_feedback_input.py +visier_platform_sdk/models/job_search_failure_output.py +visier_platform_sdk/models/job_search_input.py +visier_platform_sdk/models/job_search_output.py +visier_platform_sdk/models/job_standardization_input.py +visier_platform_sdk/models/job_standardization_input_skills.py +visier_platform_sdk/models/location_search_failure_output.py +visier_platform_sdk/models/location_search_input.py +visier_platform_sdk/models/location_search_input1.py +visier_platform_sdk/models/location_search_output.py +visier_platform_sdk/models/location_search_successful_output.py +visier_platform_sdk/models/output_entry.py +visier_platform_sdk/models/output_entry1.py +visier_platform_sdk/models/output_entry1_matches_inner.py +visier_platform_sdk/models/plan_data_load_change_dto.py +visier_platform_sdk/models/plan_data_load_change_list_dto.py +visier_platform_sdk/models/plan_data_upload_response_dto.py +visier_platform_sdk/models/plan_row_data_load_response_dto.py +visier_platform_sdk/models/planning_get_plan_list_response_dto.py +visier_platform_sdk/models/planning_plan_data_load_error_dto.py +visier_platform_sdk/models/planning_plan_info_dto.py +visier_platform_sdk/models/planning_plan_item_dto.py +visier_platform_sdk/models/planning_plan_schema_dto.py +visier_platform_sdk/models/planning_plan_segment_level_dto.py +visier_platform_sdk/models/planning_plan_segment_level_member_dto.py +visier_platform_sdk/models/planning_plan_segment_level_member_list_dto.py +visier_platform_sdk/models/planning_plan_time_period_dto.py +visier_platform_sdk/models/planning_plan_with_schema_dto.py +visier_platform_sdk/models/planning_scenario_info_dto.py +visier_platform_sdk/models/salary_benchmark_input.py +visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py +visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py +visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py +visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_request_dto.py +visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_response_dto.py +visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_request_dto.py +visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_response_dto.py +visier_platform_sdk/models/servicing_additional_capabilities_dto.py +visier_platform_sdk/models/servicing_admin_capability_config_dto.py +visier_platform_sdk/models/servicing_all_permissions_assigned_for_local_tenant_dto.py +visier_platform_sdk/models/servicing_all_profile_assigned_for_accessible_tenant_dto.py +visier_platform_sdk/models/servicing_all_profile_assigned_for_local_tenant_dto.py +visier_platform_sdk/models/servicing_all_user_groups_assigned_for_local_tenant_dto.py +visier_platform_sdk/models/servicing_all_users_get_api_response_dto.py +visier_platform_sdk/models/servicing_analytic_object_dto.py +visier_platform_sdk/models/servicing_assign_revoke_permission_by_permission_dto.py +visier_platform_sdk/models/servicing_assign_revoke_permission_by_tenant_dto.py +visier_platform_sdk/models/servicing_assign_revoke_permission_by_user_dto.py +visier_platform_sdk/models/servicing_assign_revoke_permission_request_dto.py +visier_platform_sdk/models/servicing_assign_revoke_permissions_request_dto.py +visier_platform_sdk/models/servicing_assign_revoke_permissions_response_dto.py +visier_platform_sdk/models/servicing_bulk_data_access_set_response_dto.py +visier_platform_sdk/models/servicing_capabilities_dto.py +visier_platform_sdk/models/servicing_capability_dto.py +visier_platform_sdk/models/servicing_capability_group_dto.py +visier_platform_sdk/models/servicing_commit_and_publish_operation_response_dto.py +visier_platform_sdk/models/servicing_commit_dto.py +visier_platform_sdk/models/servicing_content_package_dto.py +visier_platform_sdk/models/servicing_create_data_access_set_request_dto.py +visier_platform_sdk/models/servicing_data_access_set_dto.py +visier_platform_sdk/models/servicing_data_access_set_error_dto.py +visier_platform_sdk/models/servicing_data_access_set_failure_dto.py +visier_platform_sdk/models/servicing_data_access_set_success_dto.py +visier_platform_sdk/models/servicing_data_categories_response_dto.py +visier_platform_sdk/models/servicing_data_category_response_dto.py +visier_platform_sdk/models/servicing_data_security_profile_dto.py +visier_platform_sdk/models/servicing_delete_permissions_request_dto.py +visier_platform_sdk/models/servicing_dimension_filter_dto.py +visier_platform_sdk/models/servicing_direct_data_job_config_dto.py +visier_platform_sdk/models/servicing_direct_data_job_status_response_dto.py +visier_platform_sdk/models/servicing_direct_data_list_transactions_response_dto.py +visier_platform_sdk/models/servicing_direct_data_load_config_dto.py +visier_platform_sdk/models/servicing_direct_data_schema_dto.py +visier_platform_sdk/models/servicing_direct_data_schema_field_dto.py +visier_platform_sdk/models/servicing_direct_data_transaction_dto.py +visier_platform_sdk/models/servicing_direct_data_transaction_start_response_dto.py +visier_platform_sdk/models/servicing_direct_data_upload_file_response_dto.py +visier_platform_sdk/models/servicing_document_search_link_dto.py +visier_platform_sdk/models/servicing_dynamic_dimension_filter_dto.py +visier_platform_sdk/models/servicing_dynamic_property_mapping_dto.py +visier_platform_sdk/models/servicing_error_dto.py +visier_platform_sdk/models/servicing_export_production_versions_api_operation_parameters_dto.py +visier_platform_sdk/models/servicing_failed_accessible_tenant_profile_assignment_dto.py +visier_platform_sdk/models/servicing_failed_local_tenant_profile_assignment_dto.py +visier_platform_sdk/models/servicing_failed_local_tenant_profile_revoke_dto.py +visier_platform_sdk/models/servicing_get_capabilities_api_response_dto.py +visier_platform_sdk/models/servicing_get_content_packages_api_response_dto.py +visier_platform_sdk/models/servicing_get_data_access_sets_api_response_dto.py +visier_platform_sdk/models/servicing_get_data_security_objects_api_response_dto.py +visier_platform_sdk/models/servicing_get_permissions_api_response_dto.py +visier_platform_sdk/models/servicing_get_production_versions_api_response_dto.py +visier_platform_sdk/models/servicing_get_projects_api_response_dto.py +visier_platform_sdk/models/servicing_hierarchy_property_dto.py +visier_platform_sdk/models/servicing_inherited_access_config_dto.py +visier_platform_sdk/models/servicing_inherited_reference_member_filter_config_dto.py +visier_platform_sdk/models/servicing_job_id_response.py +visier_platform_sdk/models/servicing_last_login_dto.py +visier_platform_sdk/models/servicing_local_tenant_profile_assignment_request_dto.py +visier_platform_sdk/models/servicing_local_tenant_profile_assignment_response_dto.py +visier_platform_sdk/models/servicing_local_tenant_profile_revoke_request_dto.py +visier_platform_sdk/models/servicing_local_tenant_profile_revoke_response_dto.py +visier_platform_sdk/models/servicing_member_filter_config_dto.py +visier_platform_sdk/models/servicing_member_selection_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_calculated_property_type_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_dependent_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definition_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_dimensions_change_definitions_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_object_change_failure_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_object_change_success_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_objects_bulk_change_response_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_properties_change_definitions_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_properties_delete_definitions_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_property_bulk_delete_response_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_property_change_definition_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_property_change_definitions_by_tenant_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_property_delete_definitions_by_tenant_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_property_delete_failure_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_property_delete_success_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_property_type_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_simple_property_type_dto.py +visier_platform_sdk/models/servicing_objectconfiguration_tags_dto.py +visier_platform_sdk/models/servicing_permission_assigned_by_tenant_dto.py +visier_platform_sdk/models/servicing_permission_assigned_for_local_tenant_dto.py +visier_platform_sdk/models/servicing_permission_assigned_user_dto.py +visier_platform_sdk/models/servicing_permission_assigned_users_dto.py +visier_platform_sdk/models/servicing_permission_bulk_operation_response_dto.py +visier_platform_sdk/models/servicing_permission_dto.py +visier_platform_sdk/models/servicing_permission_error_dto.py +visier_platform_sdk/models/servicing_permission_failure_dto.py +visier_platform_sdk/models/servicing_permission_success_dto.py +visier_platform_sdk/models/servicing_production_version_api_operation_request_dto.py +visier_platform_sdk/models/servicing_production_version_api_operation_response_dto.py +visier_platform_sdk/models/servicing_production_versions_api_operation_request_dto.py +visier_platform_sdk/models/servicing_production_versions_api_operation_response_dto.py +visier_platform_sdk/models/servicing_profile_assigned_for_accessible_tenant_dto.py +visier_platform_sdk/models/servicing_profile_assigned_for_local_tenant_dto.py +visier_platform_sdk/models/servicing_profile_get_api_response_dto.py +visier_platform_sdk/models/servicing_profiles_get_api_response_dto.py +visier_platform_sdk/models/servicing_project_commits_api_response_dto.py +visier_platform_sdk/models/servicing_project_dto.py +visier_platform_sdk/models/servicing_project_operation_request_dto.py +visier_platform_sdk/models/servicing_project_operation_response_dto.py +visier_platform_sdk/models/servicing_property_access_config_dto.py +visier_platform_sdk/models/servicing_property_set_config_dto.py +visier_platform_sdk/models/servicing_question_categories_api_response_dto.py +visier_platform_sdk/models/servicing_question_category_api_response_dto.py +visier_platform_sdk/models/servicing_reduced_error_dto.py +visier_platform_sdk/models/servicing_reduced_tenant_code_error_dto.py +visier_platform_sdk/models/servicing_reduced_user_id_error_dto.py +visier_platform_sdk/models/servicing_related_analytic_object_dto.py +visier_platform_sdk/models/servicing_role_modules_config_dto.py +visier_platform_sdk/models/servicing_sample_question_api_response_dto.py +visier_platform_sdk/models/servicing_sample_questions_api_response_dto.py +visier_platform_sdk/models/servicing_securable_dimension_dto.py +visier_platform_sdk/models/servicing_securable_property_dto.py +visier_platform_sdk/models/servicing_servicing_capability_proto_enum_access_lookup_dto.py +visier_platform_sdk/models/servicing_shareable_data_access_set.py +visier_platform_sdk/models/servicing_simple_document_header_search_response_dto.py +visier_platform_sdk/models/servicing_simple_document_header_search_result_dto.py +visier_platform_sdk/models/servicing_sources_api_operation_request_dto.py +visier_platform_sdk/models/servicing_static_dimension_filter_dto.py +visier_platform_sdk/models/servicing_successful_accessible_tenant_profile_assignment_dto.py +visier_platform_sdk/models/servicing_successful_local_tenant_profile_assignment_dto.py +visier_platform_sdk/models/servicing_target_tenant_code_dto.py +visier_platform_sdk/models/servicing_tenant_code_error_dto.py +visier_platform_sdk/models/servicing_tenant_data_upload_status_response_dto.py +visier_platform_sdk/models/servicing_tenant_data_upload_update_status_response_dto.py +visier_platform_sdk/models/servicing_tenant_data_uploads_list_response_dto.py +visier_platform_sdk/models/servicing_tenant_data_uploads_response_dto.py +visier_platform_sdk/models/servicing_tenant_data_uploads_update_response_dto.py +visier_platform_sdk/models/servicing_user_creation_api_request_dto.py +visier_platform_sdk/models/servicing_user_get_api_response_dto.py +visier_platform_sdk/models/servicing_user_group_assigned_for_local_tenant_dto.py +visier_platform_sdk/models/servicing_user_group_assignment_dto.py +visier_platform_sdk/models/servicing_user_id_error_dto.py +visier_platform_sdk/models/servicing_user_property_dto.py +visier_platform_sdk/models/servicing_user_update_api_request_dto.py +visier_platform_sdk/models/servicing_users_api_error_message_dto.py +visier_platform_sdk/models/servicing_users_api_failure_dto.py +visier_platform_sdk/models/servicing_users_api_response_dto.py +visier_platform_sdk/models/servicing_users_api_success_dto.py +visier_platform_sdk/models/servicing_users_creation_api_request_dto.py +visier_platform_sdk/models/servicing_users_delete_api_request_dto.py +visier_platform_sdk/models/servicing_users_update_api_request_dto.py +visier_platform_sdk/models/servicing_users_update_api_user_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_definition_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_request_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_with_context_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_basic_information_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_bulk_change_response_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_calculated_property_type_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_definition_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_request_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_with_context_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_request_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_response_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_type_details_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_with_context_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_execution_context_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_failed_change_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_definition_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_type_details_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_object_id_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_definition_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_list_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_definition_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_list_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_list_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_list_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_type_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_list_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_property_definition_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_property_type_details_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_simple_property_type_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_successful_change_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_synonym_list_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_dto.py +visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_list_dto.py +visier_platform_sdk/models/servicing_vee_question_change_definition_dto.py +visier_platform_sdk/models/servicing_vee_question_change_definitions_by_tenant_dto.py +visier_platform_sdk/models/servicing_vee_question_change_failure_dto.py +visier_platform_sdk/models/servicing_vee_question_change_success_dto.py +visier_platform_sdk/models/servicing_vee_question_delete_definitions_by_tenant_dto.py +visier_platform_sdk/models/servicing_vee_questions_bulk_change_response_dto.py +visier_platform_sdk/models/servicing_vee_questions_change_definitions_dto.py +visier_platform_sdk/models/servicing_vee_questions_delete_definitions_dto.py +visier_platform_sdk/models/skill.py +visier_platform_sdk/models/skill_category.py +visier_platform_sdk/models/skill_category_entry.py +visier_platform_sdk/models/skill_entry.py +visier_platform_sdk/models/skill_extraction_input.py +visier_platform_sdk/models/skill_group.py +visier_platform_sdk/models/skill_group_entry.py +visier_platform_sdk/models/skill_match_input.py +visier_platform_sdk/models/source_import_result_summary_dto.py +visier_platform_sdk/models/sources_api_put_response_dto.py +visier_platform_sdk/models/sql_like200_response.py +visier_platform_sdk/models/status.py +visier_platform_sdk/models/systemstatus_system_status_dto.py +visier_platform_sdk/models/systemstatus_vee_status_dto.py +visier_platform_sdk/models/table_response_dto.py +visier_platform_sdk/models/token_response.py +visier_platform_sdk/models/user_creation_api_response_dto.py +visier_platform_sdk/py.typed +visier_platform_sdk/rest.py diff --git a/src/visier_platform_sdk/.openapi-generator/VERSION b/src/visier_platform_sdk/.openapi-generator/VERSION new file mode 100644 index 0000000000..eb1dc6a51a --- /dev/null +++ b/src/visier_platform_sdk/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.13.0 diff --git a/src/visier_platform_sdk/pyproject.toml b/src/visier_platform_sdk/pyproject.toml new file mode 100644 index 0000000000..e22dba7ee1 --- /dev/null +++ b/src/visier_platform_sdk/pyproject.toml @@ -0,0 +1,89 @@ +[tool.poetry] +name = "visier_platform_sdk" +version = "22222222.99201.1892.beta3" +description = "API Reference" +authors = ["Visier "] +license = "Apache License, Version 2.0" +readme = "README.md" +repository = "https://github.com/GIT_USER_ID/GIT_REPO_ID" +keywords = ["OpenAPI", "OpenAPI-Generator", "API Reference"] +include = ["visier_platform_sdk/py.typed"] + +[tool.poetry.dependencies] +python = "^3.9" + +urllib3 = ">= 2.1.0, < 3.0.0" +python-dateutil = ">= 2.8.2" +pydantic = ">= 2" +typing-extensions = ">= 4.7.1" + +[tool.poetry.dev-dependencies] +pytest = ">= 7.2.1" +pytest-cov = ">= 2.8.1" +tox = ">= 3.9.0" +flake8 = ">= 4.0.0" +types-python-dateutil = ">= 2.8.19.14" +mypy = ">= 1.5" + + +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[tool.pylint.'MESSAGES CONTROL'] +extension-pkg-whitelist = "pydantic" + +[tool.mypy] +files = [ + "visier_platform_sdk", + #"test", # auto-generated tests + "tests", # hand-written tests +] +# TODO: enable "strict" once all these individual checks are passing +# strict = true + +# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options +warn_unused_configs = true +warn_redundant_casts = true +warn_unused_ignores = true + +## Getting these passing should be easy +strict_equality = true +extra_checks = true + +## Strongly recommend enabling this one as soon as you can +check_untyped_defs = true + +## These shouldn't be too much additional work, but may be tricky to +## get passing if you use a lot of untyped libraries +disallow_subclassing_any = true +disallow_untyped_decorators = true +disallow_any_generics = true + +### These next few are various gradations of forcing use of type annotations +#disallow_untyped_calls = true +#disallow_incomplete_defs = true +#disallow_untyped_defs = true +# +### This one isn't too hard to get passing, but return on investment is lower +#no_implicit_reexport = true +# +### This one can be tricky to get passing if you use a lot of untyped libraries +#warn_return_any = true + +[[tool.mypy.overrides]] +module = [ + "visier_platform_sdk.configuration", +] +warn_unused_ignores = true +strict_equality = true +extra_checks = true +check_untyped_defs = true +disallow_subclassing_any = true +disallow_untyped_decorators = true +disallow_any_generics = true +disallow_untyped_calls = true +disallow_incomplete_defs = true +disallow_untyped_defs = true +no_implicit_reexport = true +warn_return_any = true diff --git a/src/visier_platform_sdk/requirements.txt b/src/visier_platform_sdk/requirements.txt new file mode 100644 index 0000000000..6cbb2b98b1 --- /dev/null +++ b/src/visier_platform_sdk/requirements.txt @@ -0,0 +1,4 @@ +urllib3 >= 2.1.0, < 3.0.0 +python_dateutil >= 2.8.2 +pydantic >= 2 +typing-extensions >= 4.7.1 diff --git a/src/visier_platform_sdk/setup.cfg b/src/visier_platform_sdk/setup.cfg new file mode 100644 index 0000000000..11433ee875 --- /dev/null +++ b/src/visier_platform_sdk/setup.cfg @@ -0,0 +1,2 @@ +[flake8] +max-line-length=99 diff --git a/src/visier_platform_sdk/setup.py b/src/visier_platform_sdk/setup.py new file mode 100644 index 0000000000..4413f1a0cd --- /dev/null +++ b/src/visier_platform_sdk/setup.py @@ -0,0 +1,51 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from setuptools import setup, find_packages # noqa: H301 + +# To install the library, run the following +# +# python setup.py install +# +# prerequisite: setuptools +# http://pypi.python.org/pypi/setuptools +NAME = "visier-platform-sdk" +VERSION = "22222222.99201.1892.beta3" +PYTHON_REQUIRES = ">= 3.9" +REQUIRES = [ + "urllib3 >= 2.1.0, < 3.0.0", + "python-dateutil >= 2.8.2", + "pydantic >= 2", + "typing-extensions >= 4.7.1", +] + +setup( + name=NAME, + version=VERSION, + description="API Reference", + author="Visier", + author_email="alpine@visier.com", + url="", + keywords=["OpenAPI", "OpenAPI-Generator", "API Reference"], + install_requires=REQUIRES, + packages=find_packages(exclude=["test", "tests"]), + include_package_data=True, + license="Apache License, Version 2.0", + long_description_content_type='text/markdown', + long_description="""\ + 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. + """, # noqa: E501 + package_data={"visier_platform_sdk": ["py.typed"]}, +) \ No newline at end of file diff --git a/src/visier_platform_sdk/test-requirements.txt b/src/visier_platform_sdk/test-requirements.txt new file mode 100644 index 0000000000..e98555c11c --- /dev/null +++ b/src/visier_platform_sdk/test-requirements.txt @@ -0,0 +1,6 @@ +pytest >= 7.2.1 +pytest-cov >= 2.8.1 +tox >= 3.9.0 +flake8 >= 4.0.0 +types-python-dateutil >= 2.8.19.14 +mypy >= 1.5 diff --git a/src/visier_platform_sdk/test/__init__.py b/src/visier_platform_sdk/test/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/src/visier_platform_sdk/test/test_admin_all_tenants_status_apidto.py b/src/visier_platform_sdk/test/test_admin_all_tenants_status_apidto.py new file mode 100644 index 0000000000..a017339385 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_all_tenants_status_apidto.py @@ -0,0 +1,85 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_all_tenants_status_apidto import AdminAllTenantsStatusAPIDTO + +class TestAdminAllTenantsStatusAPIDTO(unittest.TestCase): + """AdminAllTenantsStatusAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminAllTenantsStatusAPIDTO: + """Test AdminAllTenantsStatusAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminAllTenantsStatusAPIDTO` + """ + model = AdminAllTenantsStatusAPIDTO() + if include_optional: + return AdminAllTenantsStatusAPIDTO( + tenants = [ + visier_platform_sdk.models.admin/tenant_detail_apidto.admin.TenantDetailAPIDTO( + tenant_code = '', + tenant_display_name = '', + status = '', + provision_date = '', + current_data_version = '', + data_version_date = '', + modules = [ + visier_platform_sdk.models.designer/tenant_module_dto.designer.TenantModuleDTO( + display_name = '', + symbol_name = '', + module_settings = None, ) + ], + industry_code = 56, + can_administer_other_tenants = True, + embeddable_domains = [ + '' + ], + custom_properties = [ + visier_platform_sdk.models.admin/custom_tenant_property_dto.admin.CustomTenantPropertyDTO( + key = '', + value = '', ) + ], + sso_instance_issuers = [ + '' + ], + vanity_url_name = '', + allowed_o_auth_idp_url_domains = [ + '' + ], ) + ], + limit = 56, + start = 56 + ) + else: + return AdminAllTenantsStatusAPIDTO( + ) + """ + + def testAdminAllTenantsStatusAPIDTO(self): + """Test AdminAllTenantsStatusAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_assign_connector_credentials_by_tenant_response_dto.py b/src/visier_platform_sdk/test/test_admin_assign_connector_credentials_by_tenant_response_dto.py new file mode 100644 index 0000000000..a9d4e5c77f --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_assign_connector_credentials_by_tenant_response_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_assign_connector_credentials_by_tenant_response_dto import AdminAssignConnectorCredentialsByTenantResponseDTO + +class TestAdminAssignConnectorCredentialsByTenantResponseDTO(unittest.TestCase): + """AdminAssignConnectorCredentialsByTenantResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminAssignConnectorCredentialsByTenantResponseDTO: + """Test AdminAssignConnectorCredentialsByTenantResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminAssignConnectorCredentialsByTenantResponseDTO` + """ + model = AdminAssignConnectorCredentialsByTenantResponseDTO() + if include_optional: + return AdminAssignConnectorCredentialsByTenantResponseDTO( + tenant_code = '', + connectors = [ + visier_platform_sdk.models.admin/assign_connector_with_credentials_response_dto.admin.AssignConnectorWithCredentialsResponseDTO( + connector = None, + credential = None, ) + ], + status = 'Unknown', + message = '' + ) + else: + return AdminAssignConnectorCredentialsByTenantResponseDTO( + ) + """ + + def testAdminAssignConnectorCredentialsByTenantResponseDTO(self): + """Test AdminAssignConnectorCredentialsByTenantResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_assign_connector_credentials_response_dto.py b/src/visier_platform_sdk/test/test_admin_assign_connector_credentials_response_dto.py new file mode 100644 index 0000000000..3f204e972d --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_assign_connector_credentials_response_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_assign_connector_credentials_response_dto import AdminAssignConnectorCredentialsResponseDTO + +class TestAdminAssignConnectorCredentialsResponseDTO(unittest.TestCase): + """AdminAssignConnectorCredentialsResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminAssignConnectorCredentialsResponseDTO: + """Test AdminAssignConnectorCredentialsResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminAssignConnectorCredentialsResponseDTO` + """ + model = AdminAssignConnectorCredentialsResponseDTO() + if include_optional: + return AdminAssignConnectorCredentialsResponseDTO( + tenants = [ + visier_platform_sdk.models.admin/assign_connector_credentials_by_tenant_response_dto.admin.AssignConnectorCredentialsByTenantResponseDTO( + tenant_code = '', + connectors = [ + visier_platform_sdk.models.admin/assign_connector_with_credentials_response_dto.admin.AssignConnectorWithCredentialsResponseDTO( + connector = None, + credential = None, ) + ], + status = 'Unknown', + message = '', ) + ] + ) + else: + return AdminAssignConnectorCredentialsResponseDTO( + ) + """ + + def testAdminAssignConnectorCredentialsResponseDTO(self): + """Test AdminAssignConnectorCredentialsResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_assign_connector_with_credentials_response_dto.py b/src/visier_platform_sdk/test/test_admin_assign_connector_with_credentials_response_dto.py new file mode 100644 index 0000000000..7893e02880 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_assign_connector_with_credentials_response_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_assign_connector_with_credentials_response_dto import AdminAssignConnectorWithCredentialsResponseDTO + +class TestAdminAssignConnectorWithCredentialsResponseDTO(unittest.TestCase): + """AdminAssignConnectorWithCredentialsResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminAssignConnectorWithCredentialsResponseDTO: + """Test AdminAssignConnectorWithCredentialsResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminAssignConnectorWithCredentialsResponseDTO` + """ + model = AdminAssignConnectorWithCredentialsResponseDTO() + if include_optional: + return AdminAssignConnectorWithCredentialsResponseDTO( + connector = visier_platform_sdk.models.admin/connector_info_response_dto.admin.ConnectorInfoResponseDTO( + connector_id = '', + display_name = '', + description = '', ), + credential = visier_platform_sdk.models.admin/assigned_credential_info_response_dto.admin.AssignedCredentialInfoResponseDTO( + credential_id = '', + display_name = '', + message = '', ) + ) + else: + return AdminAssignConnectorWithCredentialsResponseDTO( + ) + """ + + def testAdminAssignConnectorWithCredentialsResponseDTO(self): + """Test AdminAssignConnectorWithCredentialsResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_assigned_credential_info_response_dto.py b/src/visier_platform_sdk/test/test_admin_assigned_credential_info_response_dto.py new file mode 100644 index 0000000000..e30b527122 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_assigned_credential_info_response_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_assigned_credential_info_response_dto import AdminAssignedCredentialInfoResponseDTO + +class TestAdminAssignedCredentialInfoResponseDTO(unittest.TestCase): + """AdminAssignedCredentialInfoResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminAssignedCredentialInfoResponseDTO: + """Test AdminAssignedCredentialInfoResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminAssignedCredentialInfoResponseDTO` + """ + model = AdminAssignedCredentialInfoResponseDTO() + if include_optional: + return AdminAssignedCredentialInfoResponseDTO( + credential_id = '', + display_name = '', + message = '' + ) + else: + return AdminAssignedCredentialInfoResponseDTO( + ) + """ + + def testAdminAssignedCredentialInfoResponseDTO(self): + """Test AdminAssignedCredentialInfoResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_batch_tenant_provision_apidto.py b/src/visier_platform_sdk/test/test_admin_batch_tenant_provision_apidto.py new file mode 100644 index 0000000000..a27c22fa7e --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_batch_tenant_provision_apidto.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_batch_tenant_provision_apidto import AdminBatchTenantProvisionAPIDTO + +class TestAdminBatchTenantProvisionAPIDTO(unittest.TestCase): + """AdminBatchTenantProvisionAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminBatchTenantProvisionAPIDTO: + """Test AdminBatchTenantProvisionAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminBatchTenantProvisionAPIDTO` + """ + model = AdminBatchTenantProvisionAPIDTO() + if include_optional: + return AdminBatchTenantProvisionAPIDTO( + tenants = [ + visier_platform_sdk.models.admin/tenant_provision_apidto.admin.TenantProvisionAPIDTO( + tenant_code = '', + tenant_display_name = '', + purchased_modules = [ + '' + ], + industry_code = 56, + embeddable_domains = [ + '' + ], + custom_properties = [ + visier_platform_sdk.models.admin/custom_tenant_property_dto.admin.CustomTenantPropertyDTO( + key = '', + value = '', ) + ], + sso_instance_issuers = [ + '' + ], + allowed_o_auth_idp_url_domains = [ + '' + ], ) + ] + ) + else: + return AdminBatchTenantProvisionAPIDTO( + ) + """ + + def testAdminBatchTenantProvisionAPIDTO(self): + """Test AdminBatchTenantProvisionAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_business_location_dto.py b/src/visier_platform_sdk/test/test_admin_business_location_dto.py new file mode 100644 index 0000000000..37b8f9bfce --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_business_location_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_business_location_dto import AdminBusinessLocationDTO + +class TestAdminBusinessLocationDTO(unittest.TestCase): + """AdminBusinessLocationDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminBusinessLocationDTO: + """Test AdminBusinessLocationDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminBusinessLocationDTO` + """ + model = AdminBusinessLocationDTO() + if include_optional: + return AdminBusinessLocationDTO( + country_code = '', + postal_code = '' + ) + else: + return AdminBusinessLocationDTO( + ) + """ + + def testAdminBusinessLocationDTO(self): + """Test AdminBusinessLocationDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_connector_info_response_dto.py b/src/visier_platform_sdk/test/test_admin_connector_info_response_dto.py new file mode 100644 index 0000000000..ff3b7b247c --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_connector_info_response_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_connector_info_response_dto import AdminConnectorInfoResponseDTO + +class TestAdminConnectorInfoResponseDTO(unittest.TestCase): + """AdminConnectorInfoResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminConnectorInfoResponseDTO: + """Test AdminConnectorInfoResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminConnectorInfoResponseDTO` + """ + model = AdminConnectorInfoResponseDTO() + if include_optional: + return AdminConnectorInfoResponseDTO( + connector_id = '', + display_name = '', + description = '' + ) + else: + return AdminConnectorInfoResponseDTO( + ) + """ + + def testAdminConnectorInfoResponseDTO(self): + """Test AdminConnectorInfoResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_connector_setting_request_dto.py b/src/visier_platform_sdk/test/test_admin_connector_setting_request_dto.py new file mode 100644 index 0000000000..869f88a854 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_connector_setting_request_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_connector_setting_request_dto import AdminConnectorSettingRequestDTO + +class TestAdminConnectorSettingRequestDTO(unittest.TestCase): + """AdminConnectorSettingRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminConnectorSettingRequestDTO: + """Test AdminConnectorSettingRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminConnectorSettingRequestDTO` + """ + model = AdminConnectorSettingRequestDTO() + if include_optional: + return AdminConnectorSettingRequestDTO( + setting_key = '', + value = '' + ) + else: + return AdminConnectorSettingRequestDTO( + ) + """ + + def testAdminConnectorSettingRequestDTO(self): + """Test AdminConnectorSettingRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_connector_setting_response_dto.py b/src/visier_platform_sdk/test/test_admin_connector_setting_response_dto.py new file mode 100644 index 0000000000..f56ebfb4ae --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_connector_setting_response_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_connector_setting_response_dto import AdminConnectorSettingResponseDTO + +class TestAdminConnectorSettingResponseDTO(unittest.TestCase): + """AdminConnectorSettingResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminConnectorSettingResponseDTO: + """Test AdminConnectorSettingResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminConnectorSettingResponseDTO` + """ + model = AdminConnectorSettingResponseDTO() + if include_optional: + return AdminConnectorSettingResponseDTO( + key = '', + value = '', + message = '' + ) + else: + return AdminConnectorSettingResponseDTO( + ) + """ + + def testAdminConnectorSettingResponseDTO(self): + """Test AdminConnectorSettingResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_connector_settings_response_dto.py b/src/visier_platform_sdk/test/test_admin_connector_settings_response_dto.py new file mode 100644 index 0000000000..6a516d8ca3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_connector_settings_response_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_connector_settings_response_dto import AdminConnectorSettingsResponseDTO + +class TestAdminConnectorSettingsResponseDTO(unittest.TestCase): + """AdminConnectorSettingsResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminConnectorSettingsResponseDTO: + """Test AdminConnectorSettingsResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminConnectorSettingsResponseDTO` + """ + model = AdminConnectorSettingsResponseDTO() + if include_optional: + return AdminConnectorSettingsResponseDTO( + connector = visier_platform_sdk.models.admin/connector_info_response_dto.admin.ConnectorInfoResponseDTO( + connector_id = '', + display_name = '', + description = '', ), + settings = [ + visier_platform_sdk.models.admin/connector_setting_response_dto.admin.ConnectorSettingResponseDTO( + key = '', + value = '', + message = '', ) + ] + ) + else: + return AdminConnectorSettingsResponseDTO( + ) + """ + + def testAdminConnectorSettingsResponseDTO(self): + """Test AdminConnectorSettingsResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_excluded_source_list_dto.py b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_excluded_source_list_dto.py new file mode 100644 index 0000000000..ebbb699b6f --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_excluded_source_list_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_consolidated_analytics_api_excluded_source_list_dto import AdminConsolidatedAnalyticsAPIExcludedSourceListDTO + +class TestAdminConsolidatedAnalyticsAPIExcludedSourceListDTO(unittest.TestCase): + """AdminConsolidatedAnalyticsAPIExcludedSourceListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminConsolidatedAnalyticsAPIExcludedSourceListDTO: + """Test AdminConsolidatedAnalyticsAPIExcludedSourceListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminConsolidatedAnalyticsAPIExcludedSourceListDTO` + """ + model = AdminConsolidatedAnalyticsAPIExcludedSourceListDTO() + if include_optional: + return AdminConsolidatedAnalyticsAPIExcludedSourceListDTO( + excluded_sources = [ + '' + ] + ) + else: + return AdminConsolidatedAnalyticsAPIExcludedSourceListDTO( + ) + """ + + def testAdminConsolidatedAnalyticsAPIExcludedSourceListDTO(self): + """Test AdminConsolidatedAnalyticsAPIExcludedSourceListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_source_tenant_list_dto.py b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_source_tenant_list_dto.py new file mode 100644 index 0000000000..c396c3d839 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_source_tenant_list_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_consolidated_analytics_api_source_tenant_list_dto import AdminConsolidatedAnalyticsAPISourceTenantListDTO + +class TestAdminConsolidatedAnalyticsAPISourceTenantListDTO(unittest.TestCase): + """AdminConsolidatedAnalyticsAPISourceTenantListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminConsolidatedAnalyticsAPISourceTenantListDTO: + """Test AdminConsolidatedAnalyticsAPISourceTenantListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminConsolidatedAnalyticsAPISourceTenantListDTO` + """ + model = AdminConsolidatedAnalyticsAPISourceTenantListDTO() + if include_optional: + return AdminConsolidatedAnalyticsAPISourceTenantListDTO( + tenant_codes = [ + '' + ] + ) + else: + return AdminConsolidatedAnalyticsAPISourceTenantListDTO( + ) + """ + + def testAdminConsolidatedAnalyticsAPISourceTenantListDTO(self): + """Test AdminConsolidatedAnalyticsAPISourceTenantListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_create_request_dto.py b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_create_request_dto.py new file mode 100644 index 0000000000..4a14a7d44a --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_create_request_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_create_request_dto import AdminConsolidatedAnalyticsAPITenantCreateRequestDTO + +class TestAdminConsolidatedAnalyticsAPITenantCreateRequestDTO(unittest.TestCase): + """AdminConsolidatedAnalyticsAPITenantCreateRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminConsolidatedAnalyticsAPITenantCreateRequestDTO: + """Test AdminConsolidatedAnalyticsAPITenantCreateRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminConsolidatedAnalyticsAPITenantCreateRequestDTO` + """ + model = AdminConsolidatedAnalyticsAPITenantCreateRequestDTO() + if include_optional: + return AdminConsolidatedAnalyticsAPITenantCreateRequestDTO( + tenant_code = '' + ) + else: + return AdminConsolidatedAnalyticsAPITenantCreateRequestDTO( + ) + """ + + def testAdminConsolidatedAnalyticsAPITenantCreateRequestDTO(self): + """Test AdminConsolidatedAnalyticsAPITenantCreateRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_list_response_dto.py b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_list_response_dto.py new file mode 100644 index 0000000000..8b93943ea8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_list_response_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_list_response_dto import AdminConsolidatedAnalyticsAPITenantListResponseDTO + +class TestAdminConsolidatedAnalyticsAPITenantListResponseDTO(unittest.TestCase): + """AdminConsolidatedAnalyticsAPITenantListResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminConsolidatedAnalyticsAPITenantListResponseDTO: + """Test AdminConsolidatedAnalyticsAPITenantListResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminConsolidatedAnalyticsAPITenantListResponseDTO` + """ + model = AdminConsolidatedAnalyticsAPITenantListResponseDTO() + if include_optional: + return AdminConsolidatedAnalyticsAPITenantListResponseDTO( + tenant_codes = [ + '' + ] + ) + else: + return AdminConsolidatedAnalyticsAPITenantListResponseDTO( + ) + """ + + def testAdminConsolidatedAnalyticsAPITenantListResponseDTO(self): + """Test AdminConsolidatedAnalyticsAPITenantListResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_with_details.py b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_with_details.py new file mode 100644 index 0000000000..01d364b333 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_with_details.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_with_details import AdminConsolidatedAnalyticsAPITenantWithDetails + +class TestAdminConsolidatedAnalyticsAPITenantWithDetails(unittest.TestCase): + """AdminConsolidatedAnalyticsAPITenantWithDetails unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminConsolidatedAnalyticsAPITenantWithDetails: + """Test AdminConsolidatedAnalyticsAPITenantWithDetails + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminConsolidatedAnalyticsAPITenantWithDetails` + """ + model = AdminConsolidatedAnalyticsAPITenantWithDetails() + if include_optional: + return AdminConsolidatedAnalyticsAPITenantWithDetails( + tenant_code = '', + source_tenants_list = [ + '' + ], + excluded_sources_list = [ + '' + ] + ) + else: + return AdminConsolidatedAnalyticsAPITenantWithDetails( + ) + """ + + def testAdminConsolidatedAnalyticsAPITenantWithDetails(self): + """Test AdminConsolidatedAnalyticsAPITenantWithDetails""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_with_details_list_response_dto.py b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_with_details_list_response_dto.py new file mode 100644 index 0000000000..1983e110d9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_consolidated_analytics_api_tenant_with_details_list_response_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_with_details_list_response_dto import AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO + +class TestAdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO(unittest.TestCase): + """AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO: + """Test AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO` + """ + model = AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO() + if include_optional: + return AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO( + tenants = [ + visier_platform_sdk.models.admin/consolidated_analytics_api_tenant_with_details.admin.ConsolidatedAnalyticsAPITenantWithDetails( + tenant_code = '', + source_tenants_list = [ + '' + ], + excluded_sources_list = [ + '' + ], ) + ] + ) + else: + return AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO( + ) + """ + + def testAdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO(self): + """Test AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_custom_property_dto.py b/src/visier_platform_sdk/test/test_admin_custom_property_dto.py new file mode 100644 index 0000000000..6f484af0bb --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_custom_property_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_custom_property_dto import AdminCustomPropertyDTO + +class TestAdminCustomPropertyDTO(unittest.TestCase): + """AdminCustomPropertyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminCustomPropertyDTO: + """Test AdminCustomPropertyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminCustomPropertyDTO` + """ + model = AdminCustomPropertyDTO() + if include_optional: + return AdminCustomPropertyDTO( + key = '', + value = '' + ) + else: + return AdminCustomPropertyDTO( + ) + """ + + def testAdminCustomPropertyDTO(self): + """Test AdminCustomPropertyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_custom_tenant_property_dto.py b/src/visier_platform_sdk/test/test_admin_custom_tenant_property_dto.py new file mode 100644 index 0000000000..2d5ffdf602 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_custom_tenant_property_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_custom_tenant_property_dto import AdminCustomTenantPropertyDTO + +class TestAdminCustomTenantPropertyDTO(unittest.TestCase): + """AdminCustomTenantPropertyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminCustomTenantPropertyDTO: + """Test AdminCustomTenantPropertyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminCustomTenantPropertyDTO` + """ + model = AdminCustomTenantPropertyDTO() + if include_optional: + return AdminCustomTenantPropertyDTO( + key = '', + value = '' + ) + else: + return AdminCustomTenantPropertyDTO( + ) + """ + + def testAdminCustomTenantPropertyDTO(self): + """Test AdminCustomTenantPropertyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_data_import_definition_apidto.py b/src/visier_platform_sdk/test/test_admin_data_import_definition_apidto.py new file mode 100644 index 0000000000..675433fabe --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_data_import_definition_apidto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_data_import_definition_apidto import AdminDataImportDefinitionAPIDTO + +class TestAdminDataImportDefinitionAPIDTO(unittest.TestCase): + """AdminDataImportDefinitionAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminDataImportDefinitionAPIDTO: + """Test AdminDataImportDefinitionAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminDataImportDefinitionAPIDTO` + """ + model = AdminDataImportDefinitionAPIDTO() + if include_optional: + return AdminDataImportDefinitionAPIDTO( + connector_id = '', + display_name = '', + credential_id = '' + ) + else: + return AdminDataImportDefinitionAPIDTO( + ) + """ + + def testAdminDataImportDefinitionAPIDTO(self): + """Test AdminDataImportDefinitionAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_data_import_definitions_apidto.py b/src/visier_platform_sdk/test/test_admin_data_import_definitions_apidto.py new file mode 100644 index 0000000000..b744f15ef5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_data_import_definitions_apidto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_data_import_definitions_apidto import AdminDataImportDefinitionsAPIDTO + +class TestAdminDataImportDefinitionsAPIDTO(unittest.TestCase): + """AdminDataImportDefinitionsAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminDataImportDefinitionsAPIDTO: + """Test AdminDataImportDefinitionsAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminDataImportDefinitionsAPIDTO` + """ + model = AdminDataImportDefinitionsAPIDTO() + if include_optional: + return AdminDataImportDefinitionsAPIDTO( + data_connectors = [ + visier_platform_sdk.models.admin/data/import_definition_apidto.admin.data.ImportDefinitionAPIDTO( + connector_id = '', + display_name = '', + credential_id = '', ) + ], + limit = 56, + start = 56 + ) + else: + return AdminDataImportDefinitionsAPIDTO( + ) + """ + + def testAdminDataImportDefinitionsAPIDTO(self): + """Test AdminDataImportDefinitionsAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_data_version_and_date_dto.py b/src/visier_platform_sdk/test/test_admin_data_version_and_date_dto.py new file mode 100644 index 0000000000..42b865d47f --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_data_version_and_date_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_data_version_and_date_dto import AdminDataVersionAndDateDTO + +class TestAdminDataVersionAndDateDTO(unittest.TestCase): + """AdminDataVersionAndDateDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminDataVersionAndDateDTO: + """Test AdminDataVersionAndDateDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminDataVersionAndDateDTO` + """ + model = AdminDataVersionAndDateDTO() + if include_optional: + return AdminDataVersionAndDateDTO( + data_version = '', + data_version_date = '' + ) + else: + return AdminDataVersionAndDateDTO( + ) + """ + + def testAdminDataVersionAndDateDTO(self): + """Test AdminDataVersionAndDateDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_delete_user_group_v2_request.py b/src/visier_platform_sdk/test/test_admin_delete_user_group_v2_request.py new file mode 100644 index 0000000000..263a3f99d4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_delete_user_group_v2_request.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_delete_user_group_v2_request import AdminDeleteUserGroupV2Request + +class TestAdminDeleteUserGroupV2Request(unittest.TestCase): + """AdminDeleteUserGroupV2Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminDeleteUserGroupV2Request: + """Test AdminDeleteUserGroupV2Request + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminDeleteUserGroupV2Request` + """ + model = AdminDeleteUserGroupV2Request() + if include_optional: + return AdminDeleteUserGroupV2Request( + user_group_id = '' + ) + else: + return AdminDeleteUserGroupV2Request( + ) + """ + + def testAdminDeleteUserGroupV2Request(self): + """Test AdminDeleteUserGroupV2Request""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_element_ids_dto.py b/src/visier_platform_sdk/test/test_admin_element_ids_dto.py new file mode 100644 index 0000000000..185b549cbe --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_element_ids_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_element_ids_dto import AdminElementIDsDTO + +class TestAdminElementIDsDTO(unittest.TestCase): + """AdminElementIDsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminElementIDsDTO: + """Test AdminElementIDsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminElementIDsDTO` + """ + model = AdminElementIDsDTO() + if include_optional: + return AdminElementIDsDTO( + ids = [ + '' + ] + ) + else: + return AdminElementIDsDTO( + ) + """ + + def testAdminElementIDsDTO(self): + """Test AdminElementIDsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_email_domains_dto.py b/src/visier_platform_sdk/test/test_admin_email_domains_dto.py new file mode 100644 index 0000000000..ee9306df92 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_email_domains_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_email_domains_dto import AdminEmailDomainsDTO + +class TestAdminEmailDomainsDTO(unittest.TestCase): + """AdminEmailDomainsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminEmailDomainsDTO: + """Test AdminEmailDomainsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminEmailDomainsDTO` + """ + model = AdminEmailDomainsDTO() + if include_optional: + return AdminEmailDomainsDTO( + domains = [ + '' + ], + confirm_not_allowed_domain = True + ) + else: + return AdminEmailDomainsDTO( + ) + """ + + def testAdminEmailDomainsDTO(self): + """Test AdminEmailDomainsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_excluded_sources_body.py b/src/visier_platform_sdk/test/test_admin_excluded_sources_body.py new file mode 100644 index 0000000000..1300856609 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_excluded_sources_body.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_excluded_sources_body import AdminExcludedSourcesBody + +class TestAdminExcludedSourcesBody(unittest.TestCase): + """AdminExcludedSourcesBody unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminExcludedSourcesBody: + """Test AdminExcludedSourcesBody + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminExcludedSourcesBody` + """ + model = AdminExcludedSourcesBody() + if include_optional: + return AdminExcludedSourcesBody( + excluded_sources = [ + '' + ] + ) + else: + return AdminExcludedSourcesBody( + ) + """ + + def testAdminExcludedSourcesBody(self): + """Test AdminExcludedSourcesBody""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_extractor_setting_apidto.py b/src/visier_platform_sdk/test/test_admin_extractor_setting_apidto.py new file mode 100644 index 0000000000..8c109bc044 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_extractor_setting_apidto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_extractor_setting_apidto import AdminExtractorSettingAPIDTO + +class TestAdminExtractorSettingAPIDTO(unittest.TestCase): + """AdminExtractorSettingAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminExtractorSettingAPIDTO: + """Test AdminExtractorSettingAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminExtractorSettingAPIDTO` + """ + model = AdminExtractorSettingAPIDTO() + if include_optional: + return AdminExtractorSettingAPIDTO( + connector_id = '', + display_name = '', + connector_settings = [ + visier_platform_sdk.models.admin/extractor_setting_key_value_apidto.admin.ExtractorSettingKeyValueAPIDTO( + setting_key = '', + value = '', ) + ] + ) + else: + return AdminExtractorSettingAPIDTO( + ) + """ + + def testAdminExtractorSettingAPIDTO(self): + """Test AdminExtractorSettingAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_extractor_setting_key_value_apidto.py b/src/visier_platform_sdk/test/test_admin_extractor_setting_key_value_apidto.py new file mode 100644 index 0000000000..b5c052dd88 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_extractor_setting_key_value_apidto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_extractor_setting_key_value_apidto import AdminExtractorSettingKeyValueAPIDTO + +class TestAdminExtractorSettingKeyValueAPIDTO(unittest.TestCase): + """AdminExtractorSettingKeyValueAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminExtractorSettingKeyValueAPIDTO: + """Test AdminExtractorSettingKeyValueAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminExtractorSettingKeyValueAPIDTO` + """ + model = AdminExtractorSettingKeyValueAPIDTO() + if include_optional: + return AdminExtractorSettingKeyValueAPIDTO( + setting_key = '', + value = '' + ) + else: + return AdminExtractorSettingKeyValueAPIDTO( + ) + """ + + def testAdminExtractorSettingKeyValueAPIDTO(self): + """Test AdminExtractorSettingKeyValueAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_extractor_settings_apidto.py b/src/visier_platform_sdk/test/test_admin_extractor_settings_apidto.py new file mode 100644 index 0000000000..109c11177f --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_extractor_settings_apidto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_extractor_settings_apidto import AdminExtractorSettingsAPIDTO + +class TestAdminExtractorSettingsAPIDTO(unittest.TestCase): + """AdminExtractorSettingsAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminExtractorSettingsAPIDTO: + """Test AdminExtractorSettingsAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminExtractorSettingsAPIDTO` + """ + model = AdminExtractorSettingsAPIDTO() + if include_optional: + return AdminExtractorSettingsAPIDTO( + connectors = [ + visier_platform_sdk.models.admin/extractor_setting_apidto.admin.ExtractorSettingAPIDTO( + connector_id = '', + display_name = '', + connector_settings = [ + visier_platform_sdk.models.admin/extractor_setting_key_value_apidto.admin.ExtractorSettingKeyValueAPIDTO( + setting_key = '', + value = '', ) + ], ) + ] + ) + else: + return AdminExtractorSettingsAPIDTO( + ) + """ + + def testAdminExtractorSettingsAPIDTO(self): + """Test AdminExtractorSettingsAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_home_analysis_by_user_group_dto.py b/src/visier_platform_sdk/test/test_admin_home_analysis_by_user_group_dto.py new file mode 100644 index 0000000000..e45385fbbb --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_home_analysis_by_user_group_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_home_analysis_by_user_group_dto import AdminHomeAnalysisByUserGroupDTO + +class TestAdminHomeAnalysisByUserGroupDTO(unittest.TestCase): + """AdminHomeAnalysisByUserGroupDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminHomeAnalysisByUserGroupDTO: + """Test AdminHomeAnalysisByUserGroupDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminHomeAnalysisByUserGroupDTO` + """ + model = AdminHomeAnalysisByUserGroupDTO() + if include_optional: + return AdminHomeAnalysisByUserGroupDTO( + user_group_id = '', + home_analysis_id = '' + ) + else: + return AdminHomeAnalysisByUserGroupDTO( + ) + """ + + def testAdminHomeAnalysisByUserGroupDTO(self): + """Test AdminHomeAnalysisByUserGroupDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_jobs_consolidated_analytics_job_request_dto.py b/src/visier_platform_sdk/test/test_admin_jobs_consolidated_analytics_job_request_dto.py new file mode 100644 index 0000000000..821364e788 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_jobs_consolidated_analytics_job_request_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_jobs_consolidated_analytics_job_request_dto import AdminJobsConsolidatedAnalyticsJobRequestDTO + +class TestAdminJobsConsolidatedAnalyticsJobRequestDTO(unittest.TestCase): + """AdminJobsConsolidatedAnalyticsJobRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminJobsConsolidatedAnalyticsJobRequestDTO: + """Test AdminJobsConsolidatedAnalyticsJobRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminJobsConsolidatedAnalyticsJobRequestDTO` + """ + model = AdminJobsConsolidatedAnalyticsJobRequestDTO() + if include_optional: + return AdminJobsConsolidatedAnalyticsJobRequestDTO( + tenant_code = '' + ) + else: + return AdminJobsConsolidatedAnalyticsJobRequestDTO( + ) + """ + + def testAdminJobsConsolidatedAnalyticsJobRequestDTO(self): + """Test AdminJobsConsolidatedAnalyticsJobRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_jobs_extract_data_and_load_dto.py b/src/visier_platform_sdk/test/test_admin_jobs_extract_data_and_load_dto.py new file mode 100644 index 0000000000..f52d8b99ab --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_jobs_extract_data_and_load_dto.py @@ -0,0 +1,79 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_jobs_extract_data_and_load_dto import AdminJobsExtractDataAndLoadDTO + +class TestAdminJobsExtractDataAndLoadDTO(unittest.TestCase): + """AdminJobsExtractDataAndLoadDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminJobsExtractDataAndLoadDTO: + """Test AdminJobsExtractDataAndLoadDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminJobsExtractDataAndLoadDTO` + """ + model = AdminJobsExtractDataAndLoadDTO() + if include_optional: + return AdminJobsExtractDataAndLoadDTO( + tenants = [ + '' + ], + all_tenants = True, + override_last_extraction_timestamp = '', + publish_data_load_artifacts = True, + run_processing_job = True, + data_category_id = '', + disable_artifact_generation = True, + connector_ids = [ + '' + ], + last_extraction_time_offset_weeks = 56, + months_to_extract = 56, + extract_to_time_override = '', + batch_size_override = 56, + sql_batch_size = 56, + force_update_existing_artifacts = True, + excluded_tenants = [ + '' + ], + spill_debug_info_partitions_dto = 'spillNone', + spill_debug_info_detail_level_dto = 'fileAndLine', + last_extraction_time_offset_months = 56, + last_extraction_time_offset_mode = '', + offset_week_option = '', + offset_month_option = '', + credential_id = '' + ) + else: + return AdminJobsExtractDataAndLoadDTO( + ) + """ + + def testAdminJobsExtractDataAndLoadDTO(self): + """Test AdminJobsExtractDataAndLoadDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_jobs_processing_job_request_dto.py b/src/visier_platform_sdk/test/test_admin_jobs_processing_job_request_dto.py new file mode 100644 index 0000000000..93f4b7ae16 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_jobs_processing_job_request_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_jobs_processing_job_request_dto import AdminJobsProcessingJobRequestDTO + +class TestAdminJobsProcessingJobRequestDTO(unittest.TestCase): + """AdminJobsProcessingJobRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminJobsProcessingJobRequestDTO: + """Test AdminJobsProcessingJobRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminJobsProcessingJobRequestDTO` + """ + model = AdminJobsProcessingJobRequestDTO() + if include_optional: + return AdminJobsProcessingJobRequestDTO( + tenants = [ + '' + ], + all_tenants = True, + data_category_id = '', + publish_to_production = True, + excluded_tenants = [ + '' + ] + ) + else: + return AdminJobsProcessingJobRequestDTO( + ) + """ + + def testAdminJobsProcessingJobRequestDTO(self): + """Test AdminJobsProcessingJobRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_key_name.py b/src/visier_platform_sdk/test/test_admin_key_name.py new file mode 100644 index 0000000000..5d99f5443f --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_key_name.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_key_name import AdminKeyName + +class TestAdminKeyName(unittest.TestCase): + """AdminKeyName unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminKeyName: + """Test AdminKeyName + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminKeyName` + """ + model = AdminKeyName() + if include_optional: + return AdminKeyName( + key_name = '' + ) + else: + return AdminKeyName( + ) + """ + + def testAdminKeyName(self): + """Test AdminKeyName""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_mask_message.py b/src/visier_platform_sdk/test/test_admin_mask_message.py new file mode 100644 index 0000000000..a6906d5869 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_mask_message.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_mask_message import AdminMaskMessage + +class TestAdminMaskMessage(unittest.TestCase): + """AdminMaskMessage unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminMaskMessage: + """Test AdminMaskMessage + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminMaskMessage` + """ + model = AdminMaskMessage() + if include_optional: + return AdminMaskMessage( + mask = '' + ) + else: + return AdminMaskMessage( + ) + """ + + def testAdminMaskMessage(self): + """Test AdminMaskMessage""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_multiple_tenant_data_versions_details_dto.py b/src/visier_platform_sdk/test/test_admin_multiple_tenant_data_versions_details_dto.py new file mode 100644 index 0000000000..3e06679801 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_multiple_tenant_data_versions_details_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_multiple_tenant_data_versions_details_dto import AdminMultipleTenantDataVersionsDetailsDTO + +class TestAdminMultipleTenantDataVersionsDetailsDTO(unittest.TestCase): + """AdminMultipleTenantDataVersionsDetailsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminMultipleTenantDataVersionsDetailsDTO: + """Test AdminMultipleTenantDataVersionsDetailsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminMultipleTenantDataVersionsDetailsDTO` + """ + model = AdminMultipleTenantDataVersionsDetailsDTO() + if include_optional: + return AdminMultipleTenantDataVersionsDetailsDTO( + tenant_code = '', + data_versions = [ + visier_platform_sdk.models.admin/data_version_and_date_dto.admin.DataVersionAndDateDTO( + data_version = '', + data_version_date = '', ) + ] + ) + else: + return AdminMultipleTenantDataVersionsDetailsDTO( + ) + """ + + def testAdminMultipleTenantDataVersionsDetailsDTO(self): + """Test AdminMultipleTenantDataVersionsDetailsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_multiple_tenant_data_versions_list_dto.py b/src/visier_platform_sdk/test/test_admin_multiple_tenant_data_versions_list_dto.py new file mode 100644 index 0000000000..6990c0da31 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_multiple_tenant_data_versions_list_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_multiple_tenant_data_versions_list_dto import AdminMultipleTenantDataVersionsListDTO + +class TestAdminMultipleTenantDataVersionsListDTO(unittest.TestCase): + """AdminMultipleTenantDataVersionsListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminMultipleTenantDataVersionsListDTO: + """Test AdminMultipleTenantDataVersionsListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminMultipleTenantDataVersionsListDTO` + """ + model = AdminMultipleTenantDataVersionsListDTO() + if include_optional: + return AdminMultipleTenantDataVersionsListDTO( + tenants = [ + visier_platform_sdk.models.admin/multiple_tenant_data_versions_details_dto.admin.MultipleTenantDataVersionsDetailsDTO( + tenant_code = '', + data_versions = [ + visier_platform_sdk.models.admin/data_version_and_date_dto.admin.DataVersionAndDateDTO( + data_version = '', + data_version_date = '', ) + ], ) + ], + limit = 56, + start = 56 + ) + else: + return AdminMultipleTenantDataVersionsListDTO( + ) + """ + + def testAdminMultipleTenantDataVersionsListDTO(self): + """Test AdminMultipleTenantDataVersionsListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_network_subnets_message_request.py b/src/visier_platform_sdk/test/test_admin_network_subnets_message_request.py new file mode 100644 index 0000000000..0a1fed6429 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_network_subnets_message_request.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_network_subnets_message_request import AdminNetworkSubnetsMessageRequest + +class TestAdminNetworkSubnetsMessageRequest(unittest.TestCase): + """AdminNetworkSubnetsMessageRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminNetworkSubnetsMessageRequest: + """Test AdminNetworkSubnetsMessageRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminNetworkSubnetsMessageRequest` + """ + model = AdminNetworkSubnetsMessageRequest() + if include_optional: + return AdminNetworkSubnetsMessageRequest( + network_subnets_for_api = [ + '' + ], + confirm_lockout = True + ) + else: + return AdminNetworkSubnetsMessageRequest( + ) + """ + + def testAdminNetworkSubnetsMessageRequest(self): + """Test AdminNetworkSubnetsMessageRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_network_subnets_message_response.py b/src/visier_platform_sdk/test/test_admin_network_subnets_message_response.py new file mode 100644 index 0000000000..2fdac91818 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_network_subnets_message_response.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_network_subnets_message_response import AdminNetworkSubnetsMessageResponse + +class TestAdminNetworkSubnetsMessageResponse(unittest.TestCase): + """AdminNetworkSubnetsMessageResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminNetworkSubnetsMessageResponse: + """Test AdminNetworkSubnetsMessageResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminNetworkSubnetsMessageResponse` + """ + model = AdminNetworkSubnetsMessageResponse() + if include_optional: + return AdminNetworkSubnetsMessageResponse( + network_subnets_for_api = [ + '' + ] + ) + else: + return AdminNetworkSubnetsMessageResponse( + ) + """ + + def testAdminNetworkSubnetsMessageResponse(self): + """Test AdminNetworkSubnetsMessageResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_permission_response_dto.py b/src/visier_platform_sdk/test/test_admin_permission_response_dto.py new file mode 100644 index 0000000000..3284518899 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_permission_response_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_permission_response_dto import AdminPermissionResponseDTO + +class TestAdminPermissionResponseDTO(unittest.TestCase): + """AdminPermissionResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminPermissionResponseDTO: + """Test AdminPermissionResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminPermissionResponseDTO` + """ + model = AdminPermissionResponseDTO() + if include_optional: + return AdminPermissionResponseDTO( + permission_id = '', + display_name = '' + ) + else: + return AdminPermissionResponseDTO( + ) + """ + + def testAdminPermissionResponseDTO(self): + """Test AdminPermissionResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_permissions_list_dto.py b/src/visier_platform_sdk/test/test_admin_permissions_list_dto.py new file mode 100644 index 0000000000..2615c860e7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_permissions_list_dto.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_permissions_list_dto import AdminPermissionsListDTO + +class TestAdminPermissionsListDTO(unittest.TestCase): + """AdminPermissionsListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminPermissionsListDTO: + """Test AdminPermissionsListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminPermissionsListDTO` + """ + model = AdminPermissionsListDTO() + if include_optional: + return AdminPermissionsListDTO( + permissions = [ + visier_platform_sdk.models.servicing/permission_dto.servicing.PermissionDTO( + permission_id = '', + display_name = '', + description = '', + data_security_profiles = [ + visier_platform_sdk.models.servicing/data_security_profile_dto.servicing.DataSecurityProfileDTO( + analytic_object_id = '', + property_set_config = None, + all_data_point_access = True, + member_filter_configs = [ + visier_platform_sdk.models.servicing/member_filter_config_dto.servicing.MemberFilterConfigDTO( + dimension_filters = [ + visier_platform_sdk.models.servicing/dimension_filter_dto.servicing.DimensionFilterDTO( + static_dimension_filter = visier_platform_sdk.models.servicing/static_dimension_filter_dto.servicing.StaticDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + member_selections = [ + visier_platform_sdk.models.servicing/member_selection_dto.servicing.MemberSelectionDTO( + name_path = [ + '' + ], + excluded = True, + dimension_member_status = 'Unset', ) + ], + dimension_status = 'Unset', ), + dynamic_dimension_filter = visier_platform_sdk.models.servicing/dynamic_dimension_filter_dto.servicing.DynamicDimensionFilterDTO( + dimension_id = '', + dynamic_property_mappings = [ + visier_platform_sdk.models.servicing/dynamic_property_mapping_dto.servicing.DynamicPropertyMappingDTO( + hierarchy_property_id = '', + user_property = None, + hierarchy_property_status = 'Unset', ) + ], + dimension_status = 'Unset', ), ) + ], ) + ], + inherited_access_configs = [ + visier_platform_sdk.models.servicing/inherited_access_config_dto.servicing.InheritedAccessConfigDTO( + analytic_object_id = '', + remove_access = True, ) + ], + inherited_reference_member_filter_config = None, + analytic_object_status = 'Unset', ) + ], + admin_capability_config = None, + role_modules_config = None, ) + ] + ) + else: + return AdminPermissionsListDTO( + ) + """ + + def testAdminPermissionsListDTO(self): + """Test AdminPermissionsListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_permissions_to_user_group_for_tenant_dto.py b/src/visier_platform_sdk/test/test_admin_permissions_to_user_group_for_tenant_dto.py new file mode 100644 index 0000000000..3ed53275f0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_permissions_to_user_group_for_tenant_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_permissions_to_user_group_for_tenant_dto import AdminPermissionsToUserGroupForTenantDTO + +class TestAdminPermissionsToUserGroupForTenantDTO(unittest.TestCase): + """AdminPermissionsToUserGroupForTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminPermissionsToUserGroupForTenantDTO: + """Test AdminPermissionsToUserGroupForTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminPermissionsToUserGroupForTenantDTO` + """ + model = AdminPermissionsToUserGroupForTenantDTO() + if include_optional: + return AdminPermissionsToUserGroupForTenantDTO( + tenant_code = '', + status = '', + message = '', + user_groups = [ + visier_platform_sdk.models.admin/user_group_get_api_response_dto.admin.UserGroupGetAPIResponseDTO( + user_group_id = '', + display_name = '', + permissions = [ + visier_platform_sdk.models.admin/permission_response_dto.admin.PermissionResponseDTO( + permission_id = '', + display_name = '', ) + ], ) + ] + ) + else: + return AdminPermissionsToUserGroupForTenantDTO( + ) + """ + + def testAdminPermissionsToUserGroupForTenantDTO(self): + """Test AdminPermissionsToUserGroupForTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_permissions_to_user_group_request_dto.py b/src/visier_platform_sdk/test/test_admin_permissions_to_user_group_request_dto.py new file mode 100644 index 0000000000..81883e04ee --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_permissions_to_user_group_request_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_permissions_to_user_group_request_dto import AdminPermissionsToUserGroupRequestDTO + +class TestAdminPermissionsToUserGroupRequestDTO(unittest.TestCase): + """AdminPermissionsToUserGroupRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminPermissionsToUserGroupRequestDTO: + """Test AdminPermissionsToUserGroupRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminPermissionsToUserGroupRequestDTO` + """ + model = AdminPermissionsToUserGroupRequestDTO() + if include_optional: + return AdminPermissionsToUserGroupRequestDTO( + user_group_id = '', + permissions_ids = [ + '' + ] + ) + else: + return AdminPermissionsToUserGroupRequestDTO( + ) + """ + + def testAdminPermissionsToUserGroupRequestDTO(self): + """Test AdminPermissionsToUserGroupRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_permissions_to_user_groups_request_dto.py b/src/visier_platform_sdk/test/test_admin_permissions_to_user_groups_request_dto.py new file mode 100644 index 0000000000..b33e92d932 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_permissions_to_user_groups_request_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_permissions_to_user_groups_request_dto import AdminPermissionsToUserGroupsRequestDTO + +class TestAdminPermissionsToUserGroupsRequestDTO(unittest.TestCase): + """AdminPermissionsToUserGroupsRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminPermissionsToUserGroupsRequestDTO: + """Test AdminPermissionsToUserGroupsRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminPermissionsToUserGroupsRequestDTO` + """ + model = AdminPermissionsToUserGroupsRequestDTO() + if include_optional: + return AdminPermissionsToUserGroupsRequestDTO( + user_groups = [ + visier_platform_sdk.models.admin/permissions_to_user_group_request_dto.admin.PermissionsToUserGroupRequestDTO( + user_group_id = '', + permissions_ids = [ + '' + ], ) + ] + ) + else: + return AdminPermissionsToUserGroupsRequestDTO( + ) + """ + + def testAdminPermissionsToUserGroupsRequestDTO(self): + """Test AdminPermissionsToUserGroupsRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_product_release_dto.py b/src/visier_platform_sdk/test/test_admin_product_release_dto.py new file mode 100644 index 0000000000..cc6ce1c4be --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_product_release_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_product_release_dto import AdminProductReleaseDTO + +class TestAdminProductReleaseDTO(unittest.TestCase): + """AdminProductReleaseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminProductReleaseDTO: + """Test AdminProductReleaseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminProductReleaseDTO` + """ + model = AdminProductReleaseDTO() + if include_optional: + return AdminProductReleaseDTO( + product_id = '', + previous_version = '', + previous_version_end_date = '', + latest_version = '' + ) + else: + return AdminProductReleaseDTO( + ) + """ + + def testAdminProductReleaseDTO(self): + """Test AdminProductReleaseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_product_releases_dto.py b/src/visier_platform_sdk/test/test_admin_product_releases_dto.py new file mode 100644 index 0000000000..f4f5386a21 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_product_releases_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_product_releases_dto import AdminProductReleasesDTO + +class TestAdminProductReleasesDTO(unittest.TestCase): + """AdminProductReleasesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminProductReleasesDTO: + """Test AdminProductReleasesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminProductReleasesDTO` + """ + model = AdminProductReleasesDTO() + if include_optional: + return AdminProductReleasesDTO( + releases = [ + visier_platform_sdk.models.admin/product_release_dto.admin.ProductReleaseDTO( + product_id = '', + previous_version = '', + previous_version_end_date = '', + latest_version = '', ) + ] + ) + else: + return AdminProductReleasesDTO( + ) + """ + + def testAdminProductReleasesDTO(self): + """Test AdminProductReleasesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_product_version_dto.py b/src/visier_platform_sdk/test/test_admin_product_version_dto.py new file mode 100644 index 0000000000..c95531f837 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_product_version_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_product_version_dto import AdminProductVersionDTO + +class TestAdminProductVersionDTO(unittest.TestCase): + """AdminProductVersionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminProductVersionDTO: + """Test AdminProductVersionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminProductVersionDTO` + """ + model = AdminProductVersionDTO() + if include_optional: + return AdminProductVersionDTO( + product_id = '', + version = '', + tenant_codes = [ + '' + ] + ) + else: + return AdminProductVersionDTO( + ) + """ + + def testAdminProductVersionDTO(self): + """Test AdminProductVersionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_product_versions_dto.py b/src/visier_platform_sdk/test/test_admin_product_versions_dto.py new file mode 100644 index 0000000000..e6c21a00ea --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_product_versions_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_product_versions_dto import AdminProductVersionsDTO + +class TestAdminProductVersionsDTO(unittest.TestCase): + """AdminProductVersionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminProductVersionsDTO: + """Test AdminProductVersionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminProductVersionsDTO` + """ + model = AdminProductVersionsDTO() + if include_optional: + return AdminProductVersionsDTO( + versions = [ + visier_platform_sdk.models.admin/product_version_dto.admin.ProductVersionDTO( + product_id = '', + version = '', + tenant_codes = [ + '' + ], ) + ] + ) + else: + return AdminProductVersionsDTO( + ) + """ + + def testAdminProductVersionsDTO(self): + """Test AdminProductVersionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_product_versions_update_failure_tenant_response_dto.py b/src/visier_platform_sdk/test/test_admin_product_versions_update_failure_tenant_response_dto.py new file mode 100644 index 0000000000..4fc789d6a5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_product_versions_update_failure_tenant_response_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_product_versions_update_failure_tenant_response_dto import AdminProductVersionsUpdateFailureTenantResponseDTO + +class TestAdminProductVersionsUpdateFailureTenantResponseDTO(unittest.TestCase): + """AdminProductVersionsUpdateFailureTenantResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminProductVersionsUpdateFailureTenantResponseDTO: + """Test AdminProductVersionsUpdateFailureTenantResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminProductVersionsUpdateFailureTenantResponseDTO` + """ + model = AdminProductVersionsUpdateFailureTenantResponseDTO() + if include_optional: + return AdminProductVersionsUpdateFailureTenantResponseDTO( + product_id = '', + version = '', + tenant_codes = [ + '' + ], + message = '' + ) + else: + return AdminProductVersionsUpdateFailureTenantResponseDTO( + ) + """ + + def testAdminProductVersionsUpdateFailureTenantResponseDTO(self): + """Test AdminProductVersionsUpdateFailureTenantResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_product_versions_update_response_dto.py b/src/visier_platform_sdk/test/test_admin_product_versions_update_response_dto.py new file mode 100644 index 0000000000..c01feef7dc --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_product_versions_update_response_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_product_versions_update_response_dto import AdminProductVersionsUpdateResponseDTO + +class TestAdminProductVersionsUpdateResponseDTO(unittest.TestCase): + """AdminProductVersionsUpdateResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminProductVersionsUpdateResponseDTO: + """Test AdminProductVersionsUpdateResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminProductVersionsUpdateResponseDTO` + """ + model = AdminProductVersionsUpdateResponseDTO() + if include_optional: + return AdminProductVersionsUpdateResponseDTO( + successes = [ + visier_platform_sdk.models.admin/product_versions_update_successful_tenant_response_dto.admin.ProductVersionsUpdateSuccessfulTenantResponseDTO( + product_id = '', + version = '', + tenant_codes = [ + '' + ], ) + ], + failures = [ + visier_platform_sdk.models.admin/product_versions_update_failure_tenant_response_dto.admin.ProductVersionsUpdateFailureTenantResponseDTO( + product_id = '', + version = '', + tenant_codes = [ + '' + ], + message = '', ) + ] + ) + else: + return AdminProductVersionsUpdateResponseDTO( + ) + """ + + def testAdminProductVersionsUpdateResponseDTO(self): + """Test AdminProductVersionsUpdateResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_product_versions_update_successful_tenant_response_dto.py b/src/visier_platform_sdk/test/test_admin_product_versions_update_successful_tenant_response_dto.py new file mode 100644 index 0000000000..43b95379af --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_product_versions_update_successful_tenant_response_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_product_versions_update_successful_tenant_response_dto import AdminProductVersionsUpdateSuccessfulTenantResponseDTO + +class TestAdminProductVersionsUpdateSuccessfulTenantResponseDTO(unittest.TestCase): + """AdminProductVersionsUpdateSuccessfulTenantResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminProductVersionsUpdateSuccessfulTenantResponseDTO: + """Test AdminProductVersionsUpdateSuccessfulTenantResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminProductVersionsUpdateSuccessfulTenantResponseDTO` + """ + model = AdminProductVersionsUpdateSuccessfulTenantResponseDTO() + if include_optional: + return AdminProductVersionsUpdateSuccessfulTenantResponseDTO( + product_id = '', + version = '', + tenant_codes = [ + '' + ] + ) + else: + return AdminProductVersionsUpdateSuccessfulTenantResponseDTO( + ) + """ + + def testAdminProductVersionsUpdateSuccessfulTenantResponseDTO(self): + """Test AdminProductVersionsUpdateSuccessfulTenantResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_put_project_commits_request.py b/src/visier_platform_sdk/test/test_admin_put_project_commits_request.py new file mode 100644 index 0000000000..3dbf4f169f --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_put_project_commits_request.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_put_project_commits_request import AdminPutProjectCommitsRequest + +class TestAdminPutProjectCommitsRequest(unittest.TestCase): + """AdminPutProjectCommitsRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminPutProjectCommitsRequest: + """Test AdminPutProjectCommitsRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminPutProjectCommitsRequest` + """ + model = AdminPutProjectCommitsRequest() + if include_optional: + return AdminPutProjectCommitsRequest( + project_id = '' + ) + else: + return AdminPutProjectCommitsRequest( + ) + """ + + def testAdminPutProjectCommitsRequest(self): + """Test AdminPutProjectCommitsRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_security_assignment_response_dto.py b/src/visier_platform_sdk/test/test_admin_security_assignment_response_dto.py new file mode 100644 index 0000000000..0ae44858d4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_security_assignment_response_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_security_assignment_response_dto import AdminSecurityAssignmentResponseDTO + +class TestAdminSecurityAssignmentResponseDTO(unittest.TestCase): + """AdminSecurityAssignmentResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminSecurityAssignmentResponseDTO: + """Test AdminSecurityAssignmentResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminSecurityAssignmentResponseDTO` + """ + model = AdminSecurityAssignmentResponseDTO() + if include_optional: + return AdminSecurityAssignmentResponseDTO( + tenants = [ + visier_platform_sdk.models.admin/tenant_assignments_dto.admin.TenantAssignmentsDTO( + tenant_code = '', + status = 'Unknown', + message = '', + assignments = [ + visier_platform_sdk.models.admin/user_security_assignments_dto.admin.UserSecurityAssignmentsDTO( + id = '', + name = '', + users = [ + visier_platform_sdk.models.admin/simple_user_dto.admin.SimpleUserDTO( + user_id = '', + username = '', ) + ], ) + ], + project_id = '', ) + ] + ) + else: + return AdminSecurityAssignmentResponseDTO( + ) + """ + + def testAdminSecurityAssignmentResponseDTO(self): + """Test AdminSecurityAssignmentResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_set_connector_setting_request_dto.py b/src/visier_platform_sdk/test/test_admin_set_connector_setting_request_dto.py new file mode 100644 index 0000000000..725080c9fb --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_set_connector_setting_request_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_set_connector_setting_request_dto import AdminSetConnectorSettingRequestDTO + +class TestAdminSetConnectorSettingRequestDTO(unittest.TestCase): + """AdminSetConnectorSettingRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminSetConnectorSettingRequestDTO: + """Test AdminSetConnectorSettingRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminSetConnectorSettingRequestDTO` + """ + model = AdminSetConnectorSettingRequestDTO() + if include_optional: + return AdminSetConnectorSettingRequestDTO( + connector_id = '', + tenants = [ + visier_platform_sdk.models.admin/tenant_connector_settings_request_dto.admin.TenantConnectorSettingsRequestDTO( + tenant_code = '', + connector_settings = [ + visier_platform_sdk.models.admin/connector_setting_request_dto.admin.ConnectorSettingRequestDTO( + setting_key = '', + value = '', ) + ], ) + ] + ) + else: + return AdminSetConnectorSettingRequestDTO( + ) + """ + + def testAdminSetConnectorSettingRequestDTO(self): + """Test AdminSetConnectorSettingRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_set_connector_setting_response_dto.py b/src/visier_platform_sdk/test/test_admin_set_connector_setting_response_dto.py new file mode 100644 index 0000000000..caf8706688 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_set_connector_setting_response_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_set_connector_setting_response_dto import AdminSetConnectorSettingResponseDTO + +class TestAdminSetConnectorSettingResponseDTO(unittest.TestCase): + """AdminSetConnectorSettingResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminSetConnectorSettingResponseDTO: + """Test AdminSetConnectorSettingResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminSetConnectorSettingResponseDTO` + """ + model = AdminSetConnectorSettingResponseDTO() + if include_optional: + return AdminSetConnectorSettingResponseDTO( + tenant_code = '', + connectors = [ + visier_platform_sdk.models.admin/connector_settings_response_dto.admin.ConnectorSettingsResponseDTO( + connector = None, + settings = [ + visier_platform_sdk.models.admin/connector_setting_response_dto.admin.ConnectorSettingResponseDTO( + key = '', + value = '', + message = '', ) + ], ) + ], + status = 'Unknown', + message = '' + ) + else: + return AdminSetConnectorSettingResponseDTO( + ) + """ + + def testAdminSetConnectorSettingResponseDTO(self): + """Test AdminSetConnectorSettingResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_set_connector_settings_request_dto.py b/src/visier_platform_sdk/test/test_admin_set_connector_settings_request_dto.py new file mode 100644 index 0000000000..f64b23fceb --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_set_connector_settings_request_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_set_connector_settings_request_dto import AdminSetConnectorSettingsRequestDTO + +class TestAdminSetConnectorSettingsRequestDTO(unittest.TestCase): + """AdminSetConnectorSettingsRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminSetConnectorSettingsRequestDTO: + """Test AdminSetConnectorSettingsRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminSetConnectorSettingsRequestDTO` + """ + model = AdminSetConnectorSettingsRequestDTO() + if include_optional: + return AdminSetConnectorSettingsRequestDTO( + connectors = [ + visier_platform_sdk.models.admin/set_connector_setting_request_dto.admin.SetConnectorSettingRequestDTO( + connector_id = '', + tenants = [ + visier_platform_sdk.models.admin/tenant_connector_settings_request_dto.admin.TenantConnectorSettingsRequestDTO( + tenant_code = '', + connector_settings = [ + visier_platform_sdk.models.admin/connector_setting_request_dto.admin.ConnectorSettingRequestDTO( + setting_key = '', + value = '', ) + ], ) + ], ) + ] + ) + else: + return AdminSetConnectorSettingsRequestDTO( + ) + """ + + def testAdminSetConnectorSettingsRequestDTO(self): + """Test AdminSetConnectorSettingsRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_set_connector_settings_response_dto.py b/src/visier_platform_sdk/test/test_admin_set_connector_settings_response_dto.py new file mode 100644 index 0000000000..9f1368fa8a --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_set_connector_settings_response_dto.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_set_connector_settings_response_dto import AdminSetConnectorSettingsResponseDTO + +class TestAdminSetConnectorSettingsResponseDTO(unittest.TestCase): + """AdminSetConnectorSettingsResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminSetConnectorSettingsResponseDTO: + """Test AdminSetConnectorSettingsResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminSetConnectorSettingsResponseDTO` + """ + model = AdminSetConnectorSettingsResponseDTO() + if include_optional: + return AdminSetConnectorSettingsResponseDTO( + tenants = [ + visier_platform_sdk.models.admin/set_connector_setting_response_dto.admin.SetConnectorSettingResponseDTO( + tenant_code = '', + connectors = [ + visier_platform_sdk.models.admin/connector_settings_response_dto.admin.ConnectorSettingsResponseDTO( + connector = None, + settings = [ + visier_platform_sdk.models.admin/connector_setting_response_dto.admin.ConnectorSettingResponseDTO( + key = '', + value = '', + message = '', ) + ], ) + ], + status = 'Unknown', + message = '', ) + ] + ) + else: + return AdminSetConnectorSettingsResponseDTO( + ) + """ + + def testAdminSetConnectorSettingsResponseDTO(self): + """Test AdminSetConnectorSettingsResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_simple_user_dto.py b/src/visier_platform_sdk/test/test_admin_simple_user_dto.py new file mode 100644 index 0000000000..0407a6f8e9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_simple_user_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_simple_user_dto import AdminSimpleUserDTO + +class TestAdminSimpleUserDTO(unittest.TestCase): + """AdminSimpleUserDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminSimpleUserDTO: + """Test AdminSimpleUserDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminSimpleUserDTO` + """ + model = AdminSimpleUserDTO() + if include_optional: + return AdminSimpleUserDTO( + user_id = '', + username = '' + ) + else: + return AdminSimpleUserDTO( + ) + """ + + def testAdminSimpleUserDTO(self): + """Test AdminSimpleUserDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_target_project_for_tenant_dto.py b/src/visier_platform_sdk/test/test_admin_target_project_for_tenant_dto.py new file mode 100644 index 0000000000..09c640da61 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_target_project_for_tenant_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_target_project_for_tenant_dto import AdminTargetProjectForTenantDTO + +class TestAdminTargetProjectForTenantDTO(unittest.TestCase): + """AdminTargetProjectForTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTargetProjectForTenantDTO: + """Test AdminTargetProjectForTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTargetProjectForTenantDTO` + """ + model = AdminTargetProjectForTenantDTO() + if include_optional: + return AdminTargetProjectForTenantDTO( + tenant_code = '', + project_id = '' + ) + else: + return AdminTargetProjectForTenantDTO( + ) + """ + + def testAdminTargetProjectForTenantDTO(self): + """Test AdminTargetProjectForTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_target_project_for_tenants_list_dto.py b/src/visier_platform_sdk/test/test_admin_target_project_for_tenants_list_dto.py new file mode 100644 index 0000000000..8f5902ee29 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_target_project_for_tenants_list_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_target_project_for_tenants_list_dto import AdminTargetProjectForTenantsListDTO + +class TestAdminTargetProjectForTenantsListDTO(unittest.TestCase): + """AdminTargetProjectForTenantsListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTargetProjectForTenantsListDTO: + """Test AdminTargetProjectForTenantsListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTargetProjectForTenantsListDTO` + """ + model = AdminTargetProjectForTenantsListDTO() + if include_optional: + return AdminTargetProjectForTenantsListDTO( + target_project_for_tenants = [ + visier_platform_sdk.models.admin/target_project_for_tenant_dto.admin.TargetProjectForTenantDTO( + tenant_code = '', + project_id = '', ) + ] + ) + else: + return AdminTargetProjectForTenantsListDTO( + ) + """ + + def testAdminTargetProjectForTenantsListDTO(self): + """Test AdminTargetProjectForTenantsListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_assignments_dto.py b/src/visier_platform_sdk/test/test_admin_tenant_assignments_dto.py new file mode 100644 index 0000000000..35f0c25ca8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_assignments_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_assignments_dto import AdminTenantAssignmentsDTO + +class TestAdminTenantAssignmentsDTO(unittest.TestCase): + """AdminTenantAssignmentsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantAssignmentsDTO: + """Test AdminTenantAssignmentsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantAssignmentsDTO` + """ + model = AdminTenantAssignmentsDTO() + if include_optional: + return AdminTenantAssignmentsDTO( + tenant_code = '', + status = 'Unknown', + message = '', + assignments = [ + visier_platform_sdk.models.admin/user_security_assignments_dto.admin.UserSecurityAssignmentsDTO( + id = '', + name = '', + users = [ + visier_platform_sdk.models.admin/simple_user_dto.admin.SimpleUserDTO( + user_id = '', + username = '', ) + ], ) + ], + project_id = '' + ) + else: + return AdminTenantAssignmentsDTO( + ) + """ + + def testAdminTenantAssignmentsDTO(self): + """Test AdminTenantAssignmentsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_code_body.py b/src/visier_platform_sdk/test/test_admin_tenant_code_body.py new file mode 100644 index 0000000000..c830648e46 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_code_body.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_code_body import AdminTenantCodeBody + +class TestAdminTenantCodeBody(unittest.TestCase): + """AdminTenantCodeBody unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantCodeBody: + """Test AdminTenantCodeBody + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantCodeBody` + """ + model = AdminTenantCodeBody() + if include_optional: + return AdminTenantCodeBody( + tenant_codes = [ + '' + ] + ) + else: + return AdminTenantCodeBody( + ) + """ + + def testAdminTenantCodeBody(self): + """Test AdminTenantCodeBody""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_connector_settings_request_dto.py b/src/visier_platform_sdk/test/test_admin_tenant_connector_settings_request_dto.py new file mode 100644 index 0000000000..527291023c --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_connector_settings_request_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_connector_settings_request_dto import AdminTenantConnectorSettingsRequestDTO + +class TestAdminTenantConnectorSettingsRequestDTO(unittest.TestCase): + """AdminTenantConnectorSettingsRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantConnectorSettingsRequestDTO: + """Test AdminTenantConnectorSettingsRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantConnectorSettingsRequestDTO` + """ + model = AdminTenantConnectorSettingsRequestDTO() + if include_optional: + return AdminTenantConnectorSettingsRequestDTO( + tenant_code = '', + connector_settings = [ + visier_platform_sdk.models.admin/connector_setting_request_dto.admin.ConnectorSettingRequestDTO( + setting_key = '', + value = '', ) + ] + ) + else: + return AdminTenantConnectorSettingsRequestDTO( + ) + """ + + def testAdminTenantConnectorSettingsRequestDTO(self): + """Test AdminTenantConnectorSettingsRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_detail_apidto.py b/src/visier_platform_sdk/test/test_admin_tenant_detail_apidto.py new file mode 100644 index 0000000000..cf0a4de042 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_detail_apidto.py @@ -0,0 +1,80 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_detail_apidto import AdminTenantDetailAPIDTO + +class TestAdminTenantDetailAPIDTO(unittest.TestCase): + """AdminTenantDetailAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantDetailAPIDTO: + """Test AdminTenantDetailAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantDetailAPIDTO` + """ + model = AdminTenantDetailAPIDTO() + if include_optional: + return AdminTenantDetailAPIDTO( + tenant_code = '', + tenant_display_name = '', + status = '', + provision_date = '', + current_data_version = '', + data_version_date = '', + modules = [ + visier_platform_sdk.models.designer/tenant_module_dto.designer.TenantModuleDTO( + display_name = '', + symbol_name = '', + module_settings = None, ) + ], + industry_code = 56, + can_administer_other_tenants = True, + embeddable_domains = [ + '' + ], + custom_properties = [ + visier_platform_sdk.models.admin/custom_tenant_property_dto.admin.CustomTenantPropertyDTO( + key = '', + value = '', ) + ], + sso_instance_issuers = [ + '' + ], + vanity_url_name = '', + allowed_o_auth_idp_url_domains = [ + '' + ] + ) + else: + return AdminTenantDetailAPIDTO( + ) + """ + + def testAdminTenantDetailAPIDTO(self): + """Test AdminTenantDetailAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_details_traits_dto.py b/src/visier_platform_sdk/test/test_admin_tenant_details_traits_dto.py new file mode 100644 index 0000000000..0108db7023 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_details_traits_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_details_traits_dto import AdminTenantDetailsTraitsDTO + +class TestAdminTenantDetailsTraitsDTO(unittest.TestCase): + """AdminTenantDetailsTraitsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantDetailsTraitsDTO: + """Test AdminTenantDetailsTraitsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantDetailsTraitsDTO` + """ + model = AdminTenantDetailsTraitsDTO() + if include_optional: + return AdminTenantDetailsTraitsDTO( + aggregation_rights = True, + tenant_type = 'ROOT_ADMIN', + data_profile_type = 'Regular' + ) + else: + return AdminTenantDetailsTraitsDTO( + ) + """ + + def testAdminTenantDetailsTraitsDTO(self): + """Test AdminTenantDetailsTraitsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_management_api_get_response_dto.py b/src/visier_platform_sdk/test/test_admin_tenant_management_api_get_response_dto.py new file mode 100644 index 0000000000..a0ed632c0c --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_management_api_get_response_dto.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_management_api_get_response_dto import AdminTenantManagementAPIGetResponseDTO + +class TestAdminTenantManagementAPIGetResponseDTO(unittest.TestCase): + """AdminTenantManagementAPIGetResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantManagementAPIGetResponseDTO: + """Test AdminTenantManagementAPIGetResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantManagementAPIGetResponseDTO` + """ + model = AdminTenantManagementAPIGetResponseDTO() + if include_optional: + return AdminTenantManagementAPIGetResponseDTO( + tenant_code = '', + tenant_display_name = '', + status = '', + provision_date = '', + current_data_version = '', + data_version_date = '', + purchased_modules = [ + '' + ], + industry_code = 56, + primary_business_location = visier_platform_sdk.models.admin/business_location_dto.admin.BusinessLocationDTO( + country_code = '', + postal_code = '', ), + can_administer_other_tenants = True, + embeddable_domains = [ + '' + ], + custom_properties = [ + visier_platform_sdk.models.admin/custom_property_dto.admin.CustomPropertyDTO( + key = '', + value = '', ) + ], + sso_instance_issuers = [ + '' + ], + vanity_url_name = '', + home_analysis_id = '', + home_analysis_by_user_group = [ + visier_platform_sdk.models.admin/home_analysis_by_user_group_dto.admin.HomeAnalysisByUserGroupDTO( + user_group_id = '', + home_analysis_id = '', ) + ], + click_through_link = '', + click_through_link_enabled = '', + default_currency = '', + allowed_o_auth_idp_url_domains = [ + '' + ], + effective_industry_code = 56, + company_size = 56, + traits = visier_platform_sdk.models.admin/tenant_details_traits_dto.admin.TenantDetailsTraitsDTO( + aggregation_rights = True, + tenant_type = 'ROOT_ADMIN', + data_profile_type = 'Regular', ) + ) + else: + return AdminTenantManagementAPIGetResponseDTO( + ) + """ + + def testAdminTenantManagementAPIGetResponseDTO(self): + """Test AdminTenantManagementAPIGetResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_management_api_list_response_dto.py b/src/visier_platform_sdk/test/test_admin_tenant_management_api_list_response_dto.py new file mode 100644 index 0000000000..cec9cadab1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_management_api_list_response_dto.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_management_api_list_response_dto import AdminTenantManagementAPIListResponseDTO + +class TestAdminTenantManagementAPIListResponseDTO(unittest.TestCase): + """AdminTenantManagementAPIListResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantManagementAPIListResponseDTO: + """Test AdminTenantManagementAPIListResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantManagementAPIListResponseDTO` + """ + model = AdminTenantManagementAPIListResponseDTO() + if include_optional: + return AdminTenantManagementAPIListResponseDTO( + tenants = [ + visier_platform_sdk.models.admin/tenant_management_api_get_response_dto.admin.TenantManagementAPIGetResponseDTO( + tenant_code = '', + tenant_display_name = '', + status = '', + provision_date = '', + current_data_version = '', + data_version_date = '', + purchased_modules = [ + '' + ], + industry_code = 56, + primary_business_location = None, + can_administer_other_tenants = True, + embeddable_domains = [ + '' + ], + custom_properties = [ + visier_platform_sdk.models.admin/custom_property_dto.admin.CustomPropertyDTO( + key = '', + value = '', ) + ], + sso_instance_issuers = [ + '' + ], + vanity_url_name = '', + home_analysis_id = '', + home_analysis_by_user_group = [ + visier_platform_sdk.models.admin/home_analysis_by_user_group_dto.admin.HomeAnalysisByUserGroupDTO( + user_group_id = '', + home_analysis_id = '', ) + ], + click_through_link = '', + click_through_link_enabled = '', + default_currency = '', + allowed_o_auth_idp_url_domains = [ + '' + ], + effective_industry_code = 56, + company_size = 56, + traits = None, ) + ], + limit = 56, + start = 56 + ) + else: + return AdminTenantManagementAPIListResponseDTO( + ) + """ + + def testAdminTenantManagementAPIListResponseDTO(self): + """Test AdminTenantManagementAPIListResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_management_api_update_request_dto.py b/src/visier_platform_sdk/test/test_admin_tenant_management_api_update_request_dto.py new file mode 100644 index 0000000000..18454b6aba --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_management_api_update_request_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_management_api_update_request_dto import AdminTenantManagementAPIUpdateRequestDTO + +class TestAdminTenantManagementAPIUpdateRequestDTO(unittest.TestCase): + """AdminTenantManagementAPIUpdateRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantManagementAPIUpdateRequestDTO: + """Test AdminTenantManagementAPIUpdateRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantManagementAPIUpdateRequestDTO` + """ + model = AdminTenantManagementAPIUpdateRequestDTO() + if include_optional: + return AdminTenantManagementAPIUpdateRequestDTO( + tenant_code = '', + tenant_display_name = '', + tenant_short_name = '', + vanity_url_name = '', + industry_code = 56, + primary_business_location = visier_platform_sdk.models.admin/business_location_dto.admin.BusinessLocationDTO( + country_code = '', + postal_code = '', ), + purchased_modules = [ + '' + ], + embeddable_domains = [ + '' + ], + custom_properties = [ + visier_platform_sdk.models.admin/custom_property_dto.admin.CustomPropertyDTO( + key = '', + value = '', ) + ], + sso_instance_issuers = [ + '' + ], + home_analysis_id = '', + home_analysis_by_user_group = [ + visier_platform_sdk.models.admin/home_analysis_by_user_group_dto.admin.HomeAnalysisByUserGroupDTO( + user_group_id = '', + home_analysis_id = '', ) + ], + update_action = 'MERGE', + enabled = True, + click_through_link = '', + default_currency = '', + allowed_o_auth_idp_url_domains = [ + '' + ], + traits = visier_platform_sdk.models.admin/tenant_details_traits_dto.admin.TenantDetailsTraitsDTO( + aggregation_rights = True, + tenant_type = 'ROOT_ADMIN', + data_profile_type = 'Regular', ) + ) + else: + return AdminTenantManagementAPIUpdateRequestDTO( + ) + """ + + def testAdminTenantManagementAPIUpdateRequestDTO(self): + """Test AdminTenantManagementAPIUpdateRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_management_api_update_response_dto.py b/src/visier_platform_sdk/test/test_admin_tenant_management_api_update_response_dto.py new file mode 100644 index 0000000000..0a6e63fdde --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_management_api_update_response_dto.py @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_management_api_update_response_dto import AdminTenantManagementAPIUpdateResponseDTO + +class TestAdminTenantManagementAPIUpdateResponseDTO(unittest.TestCase): + """AdminTenantManagementAPIUpdateResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantManagementAPIUpdateResponseDTO: + """Test AdminTenantManagementAPIUpdateResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantManagementAPIUpdateResponseDTO` + """ + model = AdminTenantManagementAPIUpdateResponseDTO() + if include_optional: + return AdminTenantManagementAPIUpdateResponseDTO( + tenant_code = '', + tenant_display_name = '', + industry_code = 56, + primary_business_location = visier_platform_sdk.models.admin/business_location_dto.admin.BusinessLocationDTO( + country_code = '', + postal_code = '', ), + purchased_modules = [ + '' + ], + embeddable_domains = [ + '' + ], + custom_properties = [ + visier_platform_sdk.models.admin/custom_property_dto.admin.CustomPropertyDTO( + key = '', + value = '', ) + ], + sso_instance_issuers = [ + '' + ], + home_analysis_id = '', + home_analysis_by_user_group = [ + visier_platform_sdk.models.admin/home_analysis_by_user_group_dto.admin.HomeAnalysisByUserGroupDTO( + user_group_id = '', + home_analysis_id = '', ) + ], + status = '', + click_through_link = '', + vanity_url_name = '', + default_currency = '', + allowed_o_auth_idp_url_domains = [ + '' + ] + ) + else: + return AdminTenantManagementAPIUpdateResponseDTO( + ) + """ + + def testAdminTenantManagementAPIUpdateResponseDTO(self): + """Test AdminTenantManagementAPIUpdateResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_provision_apidto.py b/src/visier_platform_sdk/test/test_admin_tenant_provision_apidto.py new file mode 100644 index 0000000000..8556c72fba --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_provision_apidto.py @@ -0,0 +1,71 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_provision_apidto import AdminTenantProvisionAPIDTO + +class TestAdminTenantProvisionAPIDTO(unittest.TestCase): + """AdminTenantProvisionAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantProvisionAPIDTO: + """Test AdminTenantProvisionAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantProvisionAPIDTO` + """ + model = AdminTenantProvisionAPIDTO() + if include_optional: + return AdminTenantProvisionAPIDTO( + tenant_code = '', + tenant_display_name = '', + purchased_modules = [ + '' + ], + industry_code = 56, + embeddable_domains = [ + '' + ], + custom_properties = [ + visier_platform_sdk.models.admin/custom_tenant_property_dto.admin.CustomTenantPropertyDTO( + key = '', + value = '', ) + ], + sso_instance_issuers = [ + '' + ], + allowed_o_auth_idp_url_domains = [ + '' + ] + ) + else: + return AdminTenantProvisionAPIDTO( + ) + """ + + def testAdminTenantProvisionAPIDTO(self): + """Test AdminTenantProvisionAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_tenant_status_apidto.py b/src/visier_platform_sdk/test/test_admin_tenant_status_apidto.py new file mode 100644 index 0000000000..a8c9cccb52 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_tenant_status_apidto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_tenant_status_apidto import AdminTenantStatusAPIDTO + +class TestAdminTenantStatusAPIDTO(unittest.TestCase): + """AdminTenantStatusAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminTenantStatusAPIDTO: + """Test AdminTenantStatusAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminTenantStatusAPIDTO` + """ + model = AdminTenantStatusAPIDTO() + if include_optional: + return AdminTenantStatusAPIDTO( + tenant_code = '', + status = '', + tenant_display_name = '', + can_administer_other_tenants = True + ) + else: + return AdminTenantStatusAPIDTO( + ) + """ + + def testAdminTenantStatusAPIDTO(self): + """Test AdminTenantStatusAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_update_tenant_model.py b/src/visier_platform_sdk/test/test_admin_update_tenant_model.py new file mode 100644 index 0000000000..87275d083b --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_update_tenant_model.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_update_tenant_model import AdminUpdateTenantModel + +class TestAdminUpdateTenantModel(unittest.TestCase): + """AdminUpdateTenantModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUpdateTenantModel: + """Test AdminUpdateTenantModel + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUpdateTenantModel` + """ + model = AdminUpdateTenantModel() + if include_optional: + return AdminUpdateTenantModel( + tenant_display_name = '', + industry_code = 56, + purchased_modules = [ + '' + ], + embeddable_domains = [ + '' + ], + custom_properties = { + 'key' : '' + }, + sso_instance_issuers = [ + '' + ] + ) + else: + return AdminUpdateTenantModel( + ) + """ + + def testAdminUpdateTenantModel(self): + """Test AdminUpdateTenantModel""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_change_definition_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_change_definition_dto.py new file mode 100644 index 0000000000..314c298883 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_change_definition_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_change_definition_dto import AdminUserGroupChangeDefinitionDTO + +class TestAdminUserGroupChangeDefinitionDTO(unittest.TestCase): + """AdminUserGroupChangeDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupChangeDefinitionDTO: + """Test AdminUserGroupChangeDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupChangeDefinitionDTO` + """ + model = AdminUserGroupChangeDefinitionDTO() + if include_optional: + return AdminUserGroupChangeDefinitionDTO( + user_group_id = '', + display_name = '', + description = '', + permission_ids = visier_platform_sdk.models.admin/element_ids_dto.admin.ElementIDsDTO( + ids = [ + '' + ], ), + users = visier_platform_sdk.models.admin/user_group_change_users_dto.admin.UserGroupChangeUsersDTO( + include_all_users = True, + manually_included_ids = None, + manually_excluded_ids = None, + dynamic_filter_definition = None, ), + tenant_code = '', + project_id = '' + ) + else: + return AdminUserGroupChangeDefinitionDTO( + ) + """ + + def testAdminUserGroupChangeDefinitionDTO(self): + """Test AdminUserGroupChangeDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_change_dimension_filter_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_change_dimension_filter_dto.py new file mode 100644 index 0000000000..83fa12fa8d --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_change_dimension_filter_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_change_dimension_filter_dto import AdminUserGroupChangeDimensionFilterDTO + +class TestAdminUserGroupChangeDimensionFilterDTO(unittest.TestCase): + """AdminUserGroupChangeDimensionFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupChangeDimensionFilterDTO: + """Test AdminUserGroupChangeDimensionFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupChangeDimensionFilterDTO` + """ + model = AdminUserGroupChangeDimensionFilterDTO() + if include_optional: + return AdminUserGroupChangeDimensionFilterDTO( + dimension_id = '', + subject_reference_path = visier_platform_sdk.models.admin/element_ids_dto.admin.ElementIDsDTO( + ids = [ + '' + ], ), + member_selections = [ + visier_platform_sdk.models.admin/user_group_change_member_selection_dto.admin.UserGroupChangeMemberSelectionDTO( + is_excluded = True, + name_path = [ + '' + ], ) + ] + ) + else: + return AdminUserGroupChangeDimensionFilterDTO( + ) + """ + + def testAdminUserGroupChangeDimensionFilterDTO(self): + """Test AdminUserGroupChangeDimensionFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_change_failure_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_change_failure_dto.py new file mode 100644 index 0000000000..4d7069cf0b --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_change_failure_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_change_failure_dto import AdminUserGroupChangeFailureDTO + +class TestAdminUserGroupChangeFailureDTO(unittest.TestCase): + """AdminUserGroupChangeFailureDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupChangeFailureDTO: + """Test AdminUserGroupChangeFailureDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupChangeFailureDTO` + """ + model = AdminUserGroupChangeFailureDTO() + if include_optional: + return AdminUserGroupChangeFailureDTO( + display_name = '', + message = '', + rci = '', + tenant_code = '', + project_id = '' + ) + else: + return AdminUserGroupChangeFailureDTO( + ) + """ + + def testAdminUserGroupChangeFailureDTO(self): + """Test AdminUserGroupChangeFailureDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_change_filter_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_change_filter_dto.py new file mode 100644 index 0000000000..3496389607 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_change_filter_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_change_filter_dto import AdminUserGroupChangeFilterDTO + +class TestAdminUserGroupChangeFilterDTO(unittest.TestCase): + """AdminUserGroupChangeFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupChangeFilterDTO: + """Test AdminUserGroupChangeFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupChangeFilterDTO` + """ + model = AdminUserGroupChangeFilterDTO() + if include_optional: + return AdminUserGroupChangeFilterDTO( + filter_id = '', + analytic_object_id = '', + dimension_filters = [ + visier_platform_sdk.models.admin/user_group_change_dimension_filter_dto.admin.UserGroupChangeDimensionFilterDTO( + dimension_id = '', + subject_reference_path = None, + member_selections = [ + visier_platform_sdk.models.admin/user_group_change_member_selection_dto.admin.UserGroupChangeMemberSelectionDTO( + is_excluded = True, + name_path = [ + '' + ], ) + ], ) + ] + ) + else: + return AdminUserGroupChangeFilterDTO( + ) + """ + + def testAdminUserGroupChangeFilterDTO(self): + """Test AdminUserGroupChangeFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_change_member_selection_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_change_member_selection_dto.py new file mode 100644 index 0000000000..aa22cb7adb --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_change_member_selection_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_change_member_selection_dto import AdminUserGroupChangeMemberSelectionDTO + +class TestAdminUserGroupChangeMemberSelectionDTO(unittest.TestCase): + """AdminUserGroupChangeMemberSelectionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupChangeMemberSelectionDTO: + """Test AdminUserGroupChangeMemberSelectionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupChangeMemberSelectionDTO` + """ + model = AdminUserGroupChangeMemberSelectionDTO() + if include_optional: + return AdminUserGroupChangeMemberSelectionDTO( + is_excluded = True, + name_path = [ + '' + ] + ) + else: + return AdminUserGroupChangeMemberSelectionDTO( + ) + """ + + def testAdminUserGroupChangeMemberSelectionDTO(self): + """Test AdminUserGroupChangeMemberSelectionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_change_response_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_change_response_dto.py new file mode 100644 index 0000000000..2059a3d1ce --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_change_response_dto.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_change_response_dto import AdminUserGroupChangeResponseDTO + +class TestAdminUserGroupChangeResponseDTO(unittest.TestCase): + """AdminUserGroupChangeResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupChangeResponseDTO: + """Test AdminUserGroupChangeResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupChangeResponseDTO` + """ + model = AdminUserGroupChangeResponseDTO() + if include_optional: + return AdminUserGroupChangeResponseDTO( + successes = [ + visier_platform_sdk.models.admin/user_group_change_success_dto.admin.UserGroupChangeSuccessDTO( + display_name = '', + user_group_id = '', + tenant_code = '', + project_id = '', ) + ], + failures = [ + visier_platform_sdk.models.admin/user_group_change_failure_dto.admin.UserGroupChangeFailureDTO( + display_name = '', + message = '', + rci = '', + tenant_code = '', + project_id = '', ) + ] + ) + else: + return AdminUserGroupChangeResponseDTO( + ) + """ + + def testAdminUserGroupChangeResponseDTO(self): + """Test AdminUserGroupChangeResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_change_success_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_change_success_dto.py new file mode 100644 index 0000000000..b561aaefe6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_change_success_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_change_success_dto import AdminUserGroupChangeSuccessDTO + +class TestAdminUserGroupChangeSuccessDTO(unittest.TestCase): + """AdminUserGroupChangeSuccessDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupChangeSuccessDTO: + """Test AdminUserGroupChangeSuccessDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupChangeSuccessDTO` + """ + model = AdminUserGroupChangeSuccessDTO() + if include_optional: + return AdminUserGroupChangeSuccessDTO( + display_name = '', + user_group_id = '', + tenant_code = '', + project_id = '' + ) + else: + return AdminUserGroupChangeSuccessDTO( + ) + """ + + def testAdminUserGroupChangeSuccessDTO(self): + """Test AdminUserGroupChangeSuccessDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_change_users_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_change_users_dto.py new file mode 100644 index 0000000000..b0d5e5d184 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_change_users_dto.py @@ -0,0 +1,78 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_change_users_dto import AdminUserGroupChangeUsersDTO + +class TestAdminUserGroupChangeUsersDTO(unittest.TestCase): + """AdminUserGroupChangeUsersDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupChangeUsersDTO: + """Test AdminUserGroupChangeUsersDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupChangeUsersDTO` + """ + model = AdminUserGroupChangeUsersDTO() + if include_optional: + return AdminUserGroupChangeUsersDTO( + include_all_users = True, + manually_included_ids = visier_platform_sdk.models.admin/element_ids_dto.admin.ElementIDsDTO( + ids = [ + '' + ], ), + manually_excluded_ids = visier_platform_sdk.models.admin/element_ids_dto.admin.ElementIDsDTO( + ids = [ + '' + ], ), + dynamic_filter_definition = visier_platform_sdk.models.admin/user_group_filters_dto.admin.UserGroupFiltersDTO( + filters = [ + visier_platform_sdk.models.admin/user_group_change_filter_dto.admin.UserGroupChangeFilterDTO( + filter_id = '', + analytic_object_id = '', + dimension_filters = [ + visier_platform_sdk.models.admin/user_group_change_dimension_filter_dto.admin.UserGroupChangeDimensionFilterDTO( + dimension_id = '', + subject_reference_path = None, + member_selections = [ + visier_platform_sdk.models.admin/user_group_change_member_selection_dto.admin.UserGroupChangeMemberSelectionDTO( + is_excluded = True, + name_path = [ + '' + ], ) + ], ) + ], ) + ], ) + ) + else: + return AdminUserGroupChangeUsersDTO( + ) + """ + + def testAdminUserGroupChangeUsersDTO(self): + """Test AdminUserGroupChangeUsersDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_delete_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_delete_dto.py new file mode 100644 index 0000000000..3a3867a54e --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_delete_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_delete_dto import AdminUserGroupDeleteDTO + +class TestAdminUserGroupDeleteDTO(unittest.TestCase): + """AdminUserGroupDeleteDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupDeleteDTO: + """Test AdminUserGroupDeleteDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupDeleteDTO` + """ + model = AdminUserGroupDeleteDTO() + if include_optional: + return AdminUserGroupDeleteDTO( + tenant_code = '', + user_group_id = '', + project_id = '' + ) + else: + return AdminUserGroupDeleteDTO( + ) + """ + + def testAdminUserGroupDeleteDTO(self): + """Test AdminUserGroupDeleteDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_delete_failure_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_delete_failure_dto.py new file mode 100644 index 0000000000..d5a89de483 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_delete_failure_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_delete_failure_dto import AdminUserGroupDeleteFailureDTO + +class TestAdminUserGroupDeleteFailureDTO(unittest.TestCase): + """AdminUserGroupDeleteFailureDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupDeleteFailureDTO: + """Test AdminUserGroupDeleteFailureDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupDeleteFailureDTO` + """ + model = AdminUserGroupDeleteFailureDTO() + if include_optional: + return AdminUserGroupDeleteFailureDTO( + tenant_code = '', + user_group_id = '', + message = '', + rci = '', + project_id = '' + ) + else: + return AdminUserGroupDeleteFailureDTO( + ) + """ + + def testAdminUserGroupDeleteFailureDTO(self): + """Test AdminUserGroupDeleteFailureDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_delete_response_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_delete_response_dto.py new file mode 100644 index 0000000000..cd6f502e85 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_delete_response_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_delete_response_dto import AdminUserGroupDeleteResponseDTO + +class TestAdminUserGroupDeleteResponseDTO(unittest.TestCase): + """AdminUserGroupDeleteResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupDeleteResponseDTO: + """Test AdminUserGroupDeleteResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupDeleteResponseDTO` + """ + model = AdminUserGroupDeleteResponseDTO() + if include_optional: + return AdminUserGroupDeleteResponseDTO( + successes = [ + visier_platform_sdk.models.admin/user_group_delete_success_dto.admin.UserGroupDeleteSuccessDTO( + tenant_code = '', + user_group_id = '', + project_id = '', ) + ], + failures = [ + visier_platform_sdk.models.admin/user_group_delete_failure_dto.admin.UserGroupDeleteFailureDTO( + tenant_code = '', + user_group_id = '', + message = '', + rci = '', + project_id = '', ) + ] + ) + else: + return AdminUserGroupDeleteResponseDTO( + ) + """ + + def testAdminUserGroupDeleteResponseDTO(self): + """Test AdminUserGroupDeleteResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_delete_success_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_delete_success_dto.py new file mode 100644 index 0000000000..5d090a04ad --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_delete_success_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_delete_success_dto import AdminUserGroupDeleteSuccessDTO + +class TestAdminUserGroupDeleteSuccessDTO(unittest.TestCase): + """AdminUserGroupDeleteSuccessDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupDeleteSuccessDTO: + """Test AdminUserGroupDeleteSuccessDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupDeleteSuccessDTO` + """ + model = AdminUserGroupDeleteSuccessDTO() + if include_optional: + return AdminUserGroupDeleteSuccessDTO( + tenant_code = '', + user_group_id = '', + project_id = '' + ) + else: + return AdminUserGroupDeleteSuccessDTO( + ) + """ + + def testAdminUserGroupDeleteSuccessDTO(self): + """Test AdminUserGroupDeleteSuccessDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_filters_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_filters_dto.py new file mode 100644 index 0000000000..2191cfeb1b --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_filters_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_filters_dto import AdminUserGroupFiltersDTO + +class TestAdminUserGroupFiltersDTO(unittest.TestCase): + """AdminUserGroupFiltersDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupFiltersDTO: + """Test AdminUserGroupFiltersDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupFiltersDTO` + """ + model = AdminUserGroupFiltersDTO() + if include_optional: + return AdminUserGroupFiltersDTO( + filters = [ + visier_platform_sdk.models.admin/user_group_change_filter_dto.admin.UserGroupChangeFilterDTO( + filter_id = '', + analytic_object_id = '', + dimension_filters = [ + visier_platform_sdk.models.admin/user_group_change_dimension_filter_dto.admin.UserGroupChangeDimensionFilterDTO( + dimension_id = '', + subject_reference_path = None, + member_selections = [ + visier_platform_sdk.models.admin/user_group_change_member_selection_dto.admin.UserGroupChangeMemberSelectionDTO( + is_excluded = True, + name_path = [ + '' + ], ) + ], ) + ], ) + ] + ) + else: + return AdminUserGroupFiltersDTO( + ) + """ + + def testAdminUserGroupFiltersDTO(self): + """Test AdminUserGroupFiltersDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_get_api_response_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_get_api_response_dto.py new file mode 100644 index 0000000000..100c629c30 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_get_api_response_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_get_api_response_dto import AdminUserGroupGetAPIResponseDTO + +class TestAdminUserGroupGetAPIResponseDTO(unittest.TestCase): + """AdminUserGroupGetAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupGetAPIResponseDTO: + """Test AdminUserGroupGetAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupGetAPIResponseDTO` + """ + model = AdminUserGroupGetAPIResponseDTO() + if include_optional: + return AdminUserGroupGetAPIResponseDTO( + user_group_id = '', + display_name = '', + permissions = [ + visier_platform_sdk.models.admin/permission_response_dto.admin.PermissionResponseDTO( + permission_id = '', + display_name = '', ) + ] + ) + else: + return AdminUserGroupGetAPIResponseDTO( + ) + """ + + def testAdminUserGroupGetAPIResponseDTO(self): + """Test AdminUserGroupGetAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_group_single_delete_response_dto.py b/src/visier_platform_sdk/test/test_admin_user_group_single_delete_response_dto.py new file mode 100644 index 0000000000..3af5e9aba8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_group_single_delete_response_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_group_single_delete_response_dto import AdminUserGroupSingleDeleteResponseDTO + +class TestAdminUserGroupSingleDeleteResponseDTO(unittest.TestCase): + """AdminUserGroupSingleDeleteResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupSingleDeleteResponseDTO: + """Test AdminUserGroupSingleDeleteResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupSingleDeleteResponseDTO` + """ + model = AdminUserGroupSingleDeleteResponseDTO() + if include_optional: + return AdminUserGroupSingleDeleteResponseDTO( + success = visier_platform_sdk.models.admin/user_group_delete_success_dto.admin.UserGroupDeleteSuccessDTO( + tenant_code = '', + user_group_id = '', + project_id = '', ), + failure = visier_platform_sdk.models.admin/user_group_delete_failure_dto.admin.UserGroupDeleteFailureDTO( + tenant_code = '', + user_group_id = '', + message = '', + rci = '', + project_id = '', ) + ) + else: + return AdminUserGroupSingleDeleteResponseDTO( + ) + """ + + def testAdminUserGroupSingleDeleteResponseDTO(self): + """Test AdminUserGroupSingleDeleteResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_groups_change_dto.py b/src/visier_platform_sdk/test/test_admin_user_groups_change_dto.py new file mode 100644 index 0000000000..39d1417866 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_groups_change_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_groups_change_dto import AdminUserGroupsChangeDTO + +class TestAdminUserGroupsChangeDTO(unittest.TestCase): + """AdminUserGroupsChangeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupsChangeDTO: + """Test AdminUserGroupsChangeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupsChangeDTO` + """ + model = AdminUserGroupsChangeDTO() + if include_optional: + return AdminUserGroupsChangeDTO( + user_groups = [ + visier_platform_sdk.models.admin/user_group_change_definition_dto.admin.UserGroupChangeDefinitionDTO( + user_group_id = '', + display_name = '', + description = '', + permission_ids = None, + users = None, + tenant_code = '', + project_id = '', ) + ] + ) + else: + return AdminUserGroupsChangeDTO( + ) + """ + + def testAdminUserGroupsChangeDTO(self): + """Test AdminUserGroupsChangeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_groups_delete_request_dto.py b/src/visier_platform_sdk/test/test_admin_user_groups_delete_request_dto.py new file mode 100644 index 0000000000..aab7654473 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_groups_delete_request_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_groups_delete_request_dto import AdminUserGroupsDeleteRequestDTO + +class TestAdminUserGroupsDeleteRequestDTO(unittest.TestCase): + """AdminUserGroupsDeleteRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupsDeleteRequestDTO: + """Test AdminUserGroupsDeleteRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupsDeleteRequestDTO` + """ + model = AdminUserGroupsDeleteRequestDTO() + if include_optional: + return AdminUserGroupsDeleteRequestDTO( + user_groups = [ + visier_platform_sdk.models.admin/user_group_delete_dto.admin.UserGroupDeleteDTO( + tenant_code = '', + user_group_id = '', + project_id = '', ) + ] + ) + else: + return AdminUserGroupsDeleteRequestDTO( + ) + """ + + def testAdminUserGroupsDeleteRequestDTO(self): + """Test AdminUserGroupsDeleteRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_groups_get_api_response_dto.py b/src/visier_platform_sdk/test/test_admin_user_groups_get_api_response_dto.py new file mode 100644 index 0000000000..7f20d203f9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_groups_get_api_response_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_groups_get_api_response_dto import AdminUserGroupsGetAPIResponseDTO + +class TestAdminUserGroupsGetAPIResponseDTO(unittest.TestCase): + """AdminUserGroupsGetAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupsGetAPIResponseDTO: + """Test AdminUserGroupsGetAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupsGetAPIResponseDTO` + """ + model = AdminUserGroupsGetAPIResponseDTO() + if include_optional: + return AdminUserGroupsGetAPIResponseDTO( + user_groups = [ + visier_platform_sdk.models.admin/user_group_get_api_response_dto.admin.UserGroupGetAPIResponseDTO( + user_group_id = '', + display_name = '', + permissions = [ + visier_platform_sdk.models.admin/permission_response_dto.admin.PermissionResponseDTO( + permission_id = '', + display_name = '', ) + ], ) + ], + limit = 56, + start = 56 + ) + else: + return AdminUserGroupsGetAPIResponseDTO( + ) + """ + + def testAdminUserGroupsGetAPIResponseDTO(self): + """Test AdminUserGroupsGetAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_groups_users_dto.py b/src/visier_platform_sdk/test/test_admin_user_groups_users_dto.py new file mode 100644 index 0000000000..0486a1d89a --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_groups_users_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_groups_users_dto import AdminUserGroupsUsersDTO + +class TestAdminUserGroupsUsersDTO(unittest.TestCase): + """AdminUserGroupsUsersDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupsUsersDTO: + """Test AdminUserGroupsUsersDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupsUsersDTO` + """ + model = AdminUserGroupsUsersDTO() + if include_optional: + return AdminUserGroupsUsersDTO( + tenants = [ + visier_platform_sdk.models.admin/user_groups_users_for_tenant_dto.admin.UserGroupsUsersForTenantDTO( + tenant_code = '', + users = [ + visier_platform_sdk.models.admin/simple_user_dto.admin.SimpleUserDTO( + user_id = '', + username = '', ) + ], ) + ], + limit = 56, + start = 56 + ) + else: + return AdminUserGroupsUsersDTO( + ) + """ + + def testAdminUserGroupsUsersDTO(self): + """Test AdminUserGroupsUsersDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_groups_users_for_tenant_dto.py b/src/visier_platform_sdk/test/test_admin_user_groups_users_for_tenant_dto.py new file mode 100644 index 0000000000..e26085f1ef --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_groups_users_for_tenant_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_groups_users_for_tenant_dto import AdminUserGroupsUsersForTenantDTO + +class TestAdminUserGroupsUsersForTenantDTO(unittest.TestCase): + """AdminUserGroupsUsersForTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserGroupsUsersForTenantDTO: + """Test AdminUserGroupsUsersForTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserGroupsUsersForTenantDTO` + """ + model = AdminUserGroupsUsersForTenantDTO() + if include_optional: + return AdminUserGroupsUsersForTenantDTO( + tenant_code = '', + users = [ + visier_platform_sdk.models.admin/simple_user_dto.admin.SimpleUserDTO( + user_id = '', + username = '', ) + ] + ) + else: + return AdminUserGroupsUsersForTenantDTO( + ) + """ + + def testAdminUserGroupsUsersForTenantDTO(self): + """Test AdminUserGroupsUsersForTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_user_security_assignments_dto.py b/src/visier_platform_sdk/test/test_admin_user_security_assignments_dto.py new file mode 100644 index 0000000000..918d828d99 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_user_security_assignments_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_user_security_assignments_dto import AdminUserSecurityAssignmentsDTO + +class TestAdminUserSecurityAssignmentsDTO(unittest.TestCase): + """AdminUserSecurityAssignmentsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUserSecurityAssignmentsDTO: + """Test AdminUserSecurityAssignmentsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUserSecurityAssignmentsDTO` + """ + model = AdminUserSecurityAssignmentsDTO() + if include_optional: + return AdminUserSecurityAssignmentsDTO( + id = '', + name = '', + users = [ + visier_platform_sdk.models.admin/simple_user_dto.admin.SimpleUserDTO( + user_id = '', + username = '', ) + ] + ) + else: + return AdminUserSecurityAssignmentsDTO( + ) + """ + + def testAdminUserSecurityAssignmentsDTO(self): + """Test AdminUserSecurityAssignmentsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_users_to_user_group_request_dto.py b/src/visier_platform_sdk/test/test_admin_users_to_user_group_request_dto.py new file mode 100644 index 0000000000..534b790f4e --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_users_to_user_group_request_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_users_to_user_group_request_dto import AdminUsersToUserGroupRequestDTO + +class TestAdminUsersToUserGroupRequestDTO(unittest.TestCase): + """AdminUsersToUserGroupRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUsersToUserGroupRequestDTO: + """Test AdminUsersToUserGroupRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUsersToUserGroupRequestDTO` + """ + model = AdminUsersToUserGroupRequestDTO() + if include_optional: + return AdminUsersToUserGroupRequestDTO( + user_group_id = '', + user_ids = [ + '' + ] + ) + else: + return AdminUsersToUserGroupRequestDTO( + ) + """ + + def testAdminUsersToUserGroupRequestDTO(self): + """Test AdminUsersToUserGroupRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_admin_users_to_user_groups_request_dto.py b/src/visier_platform_sdk/test/test_admin_users_to_user_groups_request_dto.py new file mode 100644 index 0000000000..fbb5389793 --- /dev/null +++ b/src/visier_platform_sdk/test/test_admin_users_to_user_groups_request_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.admin_users_to_user_groups_request_dto import AdminUsersToUserGroupsRequestDTO + +class TestAdminUsersToUserGroupsRequestDTO(unittest.TestCase): + """AdminUsersToUserGroupsRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AdminUsersToUserGroupsRequestDTO: + """Test AdminUsersToUserGroupsRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AdminUsersToUserGroupsRequestDTO` + """ + model = AdminUsersToUserGroupsRequestDTO() + if include_optional: + return AdminUsersToUserGroupsRequestDTO( + user_groups = [ + visier_platform_sdk.models.admin/users_to_user_group_request_dto.admin.UsersToUserGroupRequestDTO( + user_group_id = '', + user_ids = [ + '' + ], ) + ], + target_project_for_tenants_list = visier_platform_sdk.models.admin/target_project_for_tenants_list_dto.admin.TargetProjectForTenantsListDTO( + target_project_for_tenants = [ + visier_platform_sdk.models.admin/target_project_for_tenant_dto.admin.TargetProjectForTenantDTO( + tenant_code = '', + project_id = '', ) + ], ) + ) + else: + return AdminUsersToUserGroupsRequestDTO( + ) + """ + + def testAdminUsersToUserGroupsRequestDTO(self): + """Test AdminUsersToUserGroupsRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_report_create_request_dto.py b/src/visier_platform_sdk/test/test_analysis_common_report_create_request_dto.py new file mode 100644 index 0000000000..50a073dacc --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_report_create_request_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_report_create_request_dto import AnalysisCommonReportCreateRequestDTO + +class TestAnalysisCommonReportCreateRequestDTO(unittest.TestCase): + """AnalysisCommonReportCreateRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonReportCreateRequestDTO: + """Test AnalysisCommonReportCreateRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonReportCreateRequestDTO` + """ + model = AnalysisCommonReportCreateRequestDTO() + if include_optional: + return AnalysisCommonReportCreateRequestDTO( + title = '', + description = '' + ) + else: + return AnalysisCommonReportCreateRequestDTO( + ) + """ + + def testAnalysisCommonReportCreateRequestDTO(self): + """Test AnalysisCommonReportCreateRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_report_delete_success_dto.py b/src/visier_platform_sdk/test/test_analysis_common_report_delete_success_dto.py new file mode 100644 index 0000000000..45ed32a409 --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_report_delete_success_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_report_delete_success_dto import AnalysisCommonReportDeleteSuccessDTO + +class TestAnalysisCommonReportDeleteSuccessDTO(unittest.TestCase): + """AnalysisCommonReportDeleteSuccessDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonReportDeleteSuccessDTO: + """Test AnalysisCommonReportDeleteSuccessDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonReportDeleteSuccessDTO` + """ + model = AnalysisCommonReportDeleteSuccessDTO() + if include_optional: + return AnalysisCommonReportDeleteSuccessDTO( + id = '' + ) + else: + return AnalysisCommonReportDeleteSuccessDTO( + ) + """ + + def testAnalysisCommonReportDeleteSuccessDTO(self): + """Test AnalysisCommonReportDeleteSuccessDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_report_dto.py b/src/visier_platform_sdk/test/test_analysis_common_report_dto.py new file mode 100644 index 0000000000..3d94ab94c3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_report_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_report_dto import AnalysisCommonReportDTO + +class TestAnalysisCommonReportDTO(unittest.TestCase): + """AnalysisCommonReportDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonReportDTO: + """Test AnalysisCommonReportDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonReportDTO` + """ + model = AnalysisCommonReportDTO() + if include_optional: + return AnalysisCommonReportDTO( + id = '', + title = '', + description = '', + updated_time = '', + is_published_report = True, + owner = '', + is_owned_by_user = True, + allowed_actions = [ + 'duplicate' + ], + link = '' + ) + else: + return AnalysisCommonReportDTO( + ) + """ + + def testAnalysisCommonReportDTO(self): + """Test AnalysisCommonReportDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_report_list_response_dto.py b/src/visier_platform_sdk/test/test_analysis_common_report_list_response_dto.py new file mode 100644 index 0000000000..83ed77d2bf --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_report_list_response_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_report_list_response_dto import AnalysisCommonReportListResponseDTO + +class TestAnalysisCommonReportListResponseDTO(unittest.TestCase): + """AnalysisCommonReportListResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonReportListResponseDTO: + """Test AnalysisCommonReportListResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonReportListResponseDTO` + """ + model = AnalysisCommonReportListResponseDTO() + if include_optional: + return AnalysisCommonReportListResponseDTO( + reports = [ + visier_platform_sdk.models.analysis/common/report_dto.analysis.common.ReportDTO( + id = '', + title = '', + description = '', + updated_time = '', + is_published_report = True, + owner = '', + is_owned_by_user = True, + allowed_actions = [ + 'duplicate' + ], + link = '', ) + ] + ) + else: + return AnalysisCommonReportListResponseDTO( + ) + """ + + def testAnalysisCommonReportListResponseDTO(self): + """Test AnalysisCommonReportListResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_clarification_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_clarification_dto.py new file mode 100644 index 0000000000..cb00f1faca --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_clarification_dto.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_clarification_dto import AnalysisCommonVeeClarificationDTO + +class TestAnalysisCommonVeeClarificationDTO(unittest.TestCase): + """AnalysisCommonVeeClarificationDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeClarificationDTO: + """Test AnalysisCommonVeeClarificationDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeClarificationDTO` + """ + model = AnalysisCommonVeeClarificationDTO() + if include_optional: + return AnalysisCommonVeeClarificationDTO( + message = '', + questions = [ + '' + ], + metrics = [ + '' + ], + dimensions = [ + '' + ], + filters = [ + '' + ], + attributes = [ + '' + ] + ) + else: + return AnalysisCommonVeeClarificationDTO( + ) + """ + + def testAnalysisCommonVeeClarificationDTO(self): + """Test AnalysisCommonVeeClarificationDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_conversation_state_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_conversation_state_dto.py new file mode 100644 index 0000000000..f3a8d59dd4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_conversation_state_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_conversation_state_dto import AnalysisCommonVeeConversationStateDTO + +class TestAnalysisCommonVeeConversationStateDTO(unittest.TestCase): + """AnalysisCommonVeeConversationStateDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeConversationStateDTO: + """Test AnalysisCommonVeeConversationStateDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeConversationStateDTO` + """ + model = AnalysisCommonVeeConversationStateDTO() + if include_optional: + return AnalysisCommonVeeConversationStateDTO( + question_state = [ + '' + ] + ) + else: + return AnalysisCommonVeeConversationStateDTO( + ) + """ + + def testAnalysisCommonVeeConversationStateDTO(self): + """Test AnalysisCommonVeeConversationStateDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_corrections_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_corrections_dto.py new file mode 100644 index 0000000000..6714b11c1f --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_corrections_dto.py @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_corrections_dto import AnalysisCommonVeeCorrectionsDTO + +class TestAnalysisCommonVeeCorrectionsDTO(unittest.TestCase): + """AnalysisCommonVeeCorrectionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeCorrectionsDTO: + """Test AnalysisCommonVeeCorrectionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeCorrectionsDTO` + """ + model = AnalysisCommonVeeCorrectionsDTO() + if include_optional: + return AnalysisCommonVeeCorrectionsDTO( + warning = [ + 'VEE_NO_WARNING' + ], + clarifications = [ + visier_platform_sdk.models.analysis/common/vee_clarification_dto.analysis.common.VeeClarificationDTO( + message = '', + questions = [ + '' + ], + metrics = [ + '' + ], + dimensions = [ + '' + ], + filters = [ + '' + ], + attributes = [ + '' + ], ) + ] + ) + else: + return AnalysisCommonVeeCorrectionsDTO( + ) + """ + + def testAnalysisCommonVeeCorrectionsDTO(self): + """Test AnalysisCommonVeeCorrectionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_data_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_data_dto.py new file mode 100644 index 0000000000..6ff5426c34 --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_data_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_data_dto import AnalysisCommonVeeDataDTO + +class TestAnalysisCommonVeeDataDTO(unittest.TestCase): + """AnalysisCommonVeeDataDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeDataDTO: + """Test AnalysisCommonVeeDataDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeDataDTO` + """ + model = AnalysisCommonVeeDataDTO() + if include_optional: + return AnalysisCommonVeeDataDTO( + data_json = '', + context = '' + ) + else: + return AnalysisCommonVeeDataDTO( + ) + """ + + def testAnalysisCommonVeeDataDTO(self): + """Test AnalysisCommonVeeDataDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_feedback_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_feedback_dto.py new file mode 100644 index 0000000000..8e8a104004 --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_feedback_dto.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_feedback_dto import AnalysisCommonVeeFeedbackDTO + +class TestAnalysisCommonVeeFeedbackDTO(unittest.TestCase): + """AnalysisCommonVeeFeedbackDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeFeedbackDTO: + """Test AnalysisCommonVeeFeedbackDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeFeedbackDTO` + """ + model = AnalysisCommonVeeFeedbackDTO() + if include_optional: + return AnalysisCommonVeeFeedbackDTO( + response = visier_platform_sdk.models.analysis/common/vee_response_dto.analysis.common.VeeResponseDTO( + conversation_state = None, + status_code = None, + narrative = '', + chart_url = '', + schema = None, + corrections = [ + visier_platform_sdk.models.analysis/common/vee_corrections_dto.analysis.common.VeeCorrectionsDTO( + warning = [ + 'VEE_NO_WARNING' + ], + clarifications = [ + visier_platform_sdk.models.analysis/common/vee_clarification_dto.analysis.common.VeeClarificationDTO( + message = '', + questions = [ + '' + ], + metrics = [ + '' + ], + dimensions = [ + '' + ], + filters = [ + '' + ], + attributes = [ + '' + ], ) + ], ) + ], + data = None, + visual = None, + reworded_question = '', ), + is_approved = True, + description = '' + ) + else: + return AnalysisCommonVeeFeedbackDTO( + ) + """ + + def testAnalysisCommonVeeFeedbackDTO(self): + """Test AnalysisCommonVeeFeedbackDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_options_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_options_dto.py new file mode 100644 index 0000000000..455dcc259a --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_options_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_options_dto import AnalysisCommonVeeOptionsDTO + +class TestAnalysisCommonVeeOptionsDTO(unittest.TestCase): + """AnalysisCommonVeeOptionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeOptionsDTO: + """Test AnalysisCommonVeeOptionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeOptionsDTO` + """ + model = AnalysisCommonVeeOptionsDTO() + if include_optional: + return AnalysisCommonVeeOptionsDTO( + include_visual = True, + visual_options = visier_platform_sdk.models.analysis/common/vee_visual_options_dto.analysis.common.VeeVisualOptionsDTO( + width = 56, + height = 56, ), + include_data = True, + data_format = 'json', + include_reworded_question = True + ) + else: + return AnalysisCommonVeeOptionsDTO( + ) + """ + + def testAnalysisCommonVeeOptionsDTO(self): + """Test AnalysisCommonVeeOptionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_question_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_question_dto.py new file mode 100644 index 0000000000..0e2277fd58 --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_question_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_question_dto import AnalysisCommonVeeQuestionDTO + +class TestAnalysisCommonVeeQuestionDTO(unittest.TestCase): + """AnalysisCommonVeeQuestionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeQuestionDTO: + """Test AnalysisCommonVeeQuestionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeQuestionDTO` + """ + model = AnalysisCommonVeeQuestionDTO() + if include_optional: + return AnalysisCommonVeeQuestionDTO( + question = '', + conversation_state = visier_platform_sdk.models.analysis/common/vee_conversation_state_dto.analysis.common.VeeConversationStateDTO( + question_state = [ + '' + ], ), + options = visier_platform_sdk.models.analysis/common/vee_options_dto.analysis.common.VeeOptionsDTO( + include_visual = True, + visual_options = None, + include_data = True, + data_format = 'json', + include_reworded_question = True, ), + max_view_details_members = 56 + ) + else: + return AnalysisCommonVeeQuestionDTO( + ) + """ + + def testAnalysisCommonVeeQuestionDTO(self): + """Test AnalysisCommonVeeQuestionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_response_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_response_dto.py new file mode 100644 index 0000000000..55c26bd82b --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_response_dto.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_response_dto import AnalysisCommonVeeResponseDTO + +class TestAnalysisCommonVeeResponseDTO(unittest.TestCase): + """AnalysisCommonVeeResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeResponseDTO: + """Test AnalysisCommonVeeResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeResponseDTO` + """ + model = AnalysisCommonVeeResponseDTO() + if include_optional: + return AnalysisCommonVeeResponseDTO( + conversation_state = visier_platform_sdk.models.analysis/common/vee_conversation_state_dto.analysis.common.VeeConversationStateDTO( + question_state = [ + '' + ], ), + status_code = visier_platform_sdk.models.analysis/common/vee_status_code_dto.analysis.common.VeeStatusCodeDTO( + status_code = 'UNDEFINED', + status_msg = '', ), + narrative = '', + chart_url = '', + var_schema = visier_platform_sdk.models.analysis/common/vee_response_schema_dto.analysis.common.VeeResponseSchemaDTO( + metrics = [ + '' + ], + dimensions = [ + visier_platform_sdk.models.analysis/common/vee_response_schema_reference_dto.analysis.common.VeeResponseSchemaReferenceDTO( + name = '', + paths = [ + '' + ], ) + ], + concepts = [ + visier_platform_sdk.models.analysis/common/vee_response_schema_reference_dto.analysis.common.VeeResponseSchemaReferenceDTO( + name = '', ) + ], ), + corrections = [ + visier_platform_sdk.models.analysis/common/vee_corrections_dto.analysis.common.VeeCorrectionsDTO( + warning = [ + 'VEE_NO_WARNING' + ], + clarifications = [ + visier_platform_sdk.models.analysis/common/vee_clarification_dto.analysis.common.VeeClarificationDTO( + message = '', + questions = [ + '' + ], + metrics = [ + '' + ], + dimensions = [ + '' + ], + filters = [ + '' + ], + attributes = [ + '' + ], ) + ], ) + ], + data = visier_platform_sdk.models.analysis/common/vee_data_dto.analysis.common.VeeDataDTO( + data_json = '', + context = '', ), + visual = visier_platform_sdk.models.analysis/common/vee_visual_dto.analysis.common.VeeVisualDTO( + image = '', + title = '', + context = '', ), + reworded_question = '' + ) + else: + return AnalysisCommonVeeResponseDTO( + ) + """ + + def testAnalysisCommonVeeResponseDTO(self): + """Test AnalysisCommonVeeResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_response_schema_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_response_schema_dto.py new file mode 100644 index 0000000000..c25292ad78 --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_response_schema_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_response_schema_dto import AnalysisCommonVeeResponseSchemaDTO + +class TestAnalysisCommonVeeResponseSchemaDTO(unittest.TestCase): + """AnalysisCommonVeeResponseSchemaDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeResponseSchemaDTO: + """Test AnalysisCommonVeeResponseSchemaDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeResponseSchemaDTO` + """ + model = AnalysisCommonVeeResponseSchemaDTO() + if include_optional: + return AnalysisCommonVeeResponseSchemaDTO( + metrics = [ + '' + ], + dimensions = [ + visier_platform_sdk.models.analysis/common/vee_response_schema_reference_dto.analysis.common.VeeResponseSchemaReferenceDTO( + name = '', + paths = [ + '' + ], ) + ], + concepts = [ + visier_platform_sdk.models.analysis/common/vee_response_schema_reference_dto.analysis.common.VeeResponseSchemaReferenceDTO( + name = '', + paths = [ + '' + ], ) + ] + ) + else: + return AnalysisCommonVeeResponseSchemaDTO( + ) + """ + + def testAnalysisCommonVeeResponseSchemaDTO(self): + """Test AnalysisCommonVeeResponseSchemaDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_response_schema_reference_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_response_schema_reference_dto.py new file mode 100644 index 0000000000..2557e8755f --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_response_schema_reference_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_response_schema_reference_dto import AnalysisCommonVeeResponseSchemaReferenceDTO + +class TestAnalysisCommonVeeResponseSchemaReferenceDTO(unittest.TestCase): + """AnalysisCommonVeeResponseSchemaReferenceDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeResponseSchemaReferenceDTO: + """Test AnalysisCommonVeeResponseSchemaReferenceDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeResponseSchemaReferenceDTO` + """ + model = AnalysisCommonVeeResponseSchemaReferenceDTO() + if include_optional: + return AnalysisCommonVeeResponseSchemaReferenceDTO( + name = '', + paths = [ + '' + ] + ) + else: + return AnalysisCommonVeeResponseSchemaReferenceDTO( + ) + """ + + def testAnalysisCommonVeeResponseSchemaReferenceDTO(self): + """Test AnalysisCommonVeeResponseSchemaReferenceDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_sample_question_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_sample_question_dto.py new file mode 100644 index 0000000000..eb75034d12 --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_sample_question_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_sample_question_dto import AnalysisCommonVeeSampleQuestionDTO + +class TestAnalysisCommonVeeSampleQuestionDTO(unittest.TestCase): + """AnalysisCommonVeeSampleQuestionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeSampleQuestionDTO: + """Test AnalysisCommonVeeSampleQuestionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeSampleQuestionDTO` + """ + model = AnalysisCommonVeeSampleQuestionDTO() + if include_optional: + return AnalysisCommonVeeSampleQuestionDTO( + question = '', + question_id = '', + category_id = '', + is_assigned_to_user = True + ) + else: + return AnalysisCommonVeeSampleQuestionDTO( + ) + """ + + def testAnalysisCommonVeeSampleQuestionDTO(self): + """Test AnalysisCommonVeeSampleQuestionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_sample_question_library_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_sample_question_library_dto.py new file mode 100644 index 0000000000..4463663ab4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_sample_question_library_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_sample_question_library_dto import AnalysisCommonVeeSampleQuestionLibraryDTO + +class TestAnalysisCommonVeeSampleQuestionLibraryDTO(unittest.TestCase): + """AnalysisCommonVeeSampleQuestionLibraryDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeSampleQuestionLibraryDTO: + """Test AnalysisCommonVeeSampleQuestionLibraryDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeSampleQuestionLibraryDTO` + """ + model = AnalysisCommonVeeSampleQuestionLibraryDTO() + if include_optional: + return AnalysisCommonVeeSampleQuestionLibraryDTO( + questions = [ + visier_platform_sdk.models.analysis/common/vee_sample_question_dto.analysis.common.VeeSampleQuestionDTO( + question = '', + question_id = '', + category_id = '', + is_assigned_to_user = True, ) + ] + ) + else: + return AnalysisCommonVeeSampleQuestionLibraryDTO( + ) + """ + + def testAnalysisCommonVeeSampleQuestionLibraryDTO(self): + """Test AnalysisCommonVeeSampleQuestionLibraryDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_status_code_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_status_code_dto.py new file mode 100644 index 0000000000..c5c25515d7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_status_code_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_status_code_dto import AnalysisCommonVeeStatusCodeDTO + +class TestAnalysisCommonVeeStatusCodeDTO(unittest.TestCase): + """AnalysisCommonVeeStatusCodeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeStatusCodeDTO: + """Test AnalysisCommonVeeStatusCodeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeStatusCodeDTO` + """ + model = AnalysisCommonVeeStatusCodeDTO() + if include_optional: + return AnalysisCommonVeeStatusCodeDTO( + status_code = 'UNDEFINED', + status_msg = '' + ) + else: + return AnalysisCommonVeeStatusCodeDTO( + ) + """ + + def testAnalysisCommonVeeStatusCodeDTO(self): + """Test AnalysisCommonVeeStatusCodeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_visual_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_visual_dto.py new file mode 100644 index 0000000000..ca78af5b7b --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_visual_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_visual_dto import AnalysisCommonVeeVisualDTO + +class TestAnalysisCommonVeeVisualDTO(unittest.TestCase): + """AnalysisCommonVeeVisualDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeVisualDTO: + """Test AnalysisCommonVeeVisualDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeVisualDTO` + """ + model = AnalysisCommonVeeVisualDTO() + if include_optional: + return AnalysisCommonVeeVisualDTO( + image = '', + title = '', + context = '' + ) + else: + return AnalysisCommonVeeVisualDTO( + ) + """ + + def testAnalysisCommonVeeVisualDTO(self): + """Test AnalysisCommonVeeVisualDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_analysis_common_vee_visual_options_dto.py b/src/visier_platform_sdk/test/test_analysis_common_vee_visual_options_dto.py new file mode 100644 index 0000000000..ef8920e53a --- /dev/null +++ b/src/visier_platform_sdk/test/test_analysis_common_vee_visual_options_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.analysis_common_vee_visual_options_dto import AnalysisCommonVeeVisualOptionsDTO + +class TestAnalysisCommonVeeVisualOptionsDTO(unittest.TestCase): + """AnalysisCommonVeeVisualOptionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AnalysisCommonVeeVisualOptionsDTO: + """Test AnalysisCommonVeeVisualOptionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AnalysisCommonVeeVisualOptionsDTO` + """ + model = AnalysisCommonVeeVisualOptionsDTO() + if include_optional: + return AnalysisCommonVeeVisualOptionsDTO( + width = 56, + height = 56 + ) + else: + return AnalysisCommonVeeVisualOptionsDTO( + ) + """ + + def testAnalysisCommonVeeVisualOptionsDTO(self): + """Test AnalysisCommonVeeVisualOptionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_api_error.py b/src/visier_platform_sdk/test/test_api_error.py new file mode 100644 index 0000000000..4de6d59615 --- /dev/null +++ b/src/visier_platform_sdk/test/test_api_error.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.api_error import ApiError + +class TestApiError(unittest.TestCase): + """ApiError unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ApiError: + """Test ApiError + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ApiError` + """ + model = ApiError() + if include_optional: + return ApiError( + error_code = '', + message = '', + rci = '' + ) + else: + return ApiError( + error_code = '', + message = '', + rci = '', + ) + """ + + def testApiError(self): + """Test ApiError""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_authentication_o_auth2_user_info_dto.py b/src/visier_platform_sdk/test/test_authentication_o_auth2_user_info_dto.py new file mode 100644 index 0000000000..ae1c3ffc03 --- /dev/null +++ b/src/visier_platform_sdk/test/test_authentication_o_auth2_user_info_dto.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.authentication_o_auth2_user_info_dto import AuthenticationOAuth2UserInfoDTO + +class TestAuthenticationOAuth2UserInfoDTO(unittest.TestCase): + """AuthenticationOAuth2UserInfoDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AuthenticationOAuth2UserInfoDTO: + """Test AuthenticationOAuth2UserInfoDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AuthenticationOAuth2UserInfoDTO` + """ + model = AuthenticationOAuth2UserInfoDTO() + if include_optional: + return AuthenticationOAuth2UserInfoDTO( + subject = '', + name = '', + email = '', + visier_user_id = '', + visier_capabilities = visier_platform_sdk.models.servicing/servicing_capability_proto_enum_access_lookup_dto.servicing.ServicingCapabilityProtoEnumAccessLookupDTO( + capability_groups = [ + visier_platform_sdk.models.servicing/capability_group_dto.servicing.CapabilityGroupDTO( + group = 'unknown', + access_level = 'NoAccess', + view_level = 'Simple', + api_access_level = 'NoAccess', + api_view_level = 'Simple', ) + ], ), + visier_subnets = visier_platform_sdk.models.authentication/o_auth2_user_subnet_info_dto.authentication.OAuth2UserSubnetInfoDTO( + access_type = 'Unknown', + subnets = [ + '' + ], ), + visier_export_subnets = visier_platform_sdk.models.authentication/o_auth2_user_subnet_info_dto.authentication.OAuth2UserSubnetInfoDTO( + access_type = 'Unknown', + subnets = [ + '' + ], ), + visier_tenant_details = visier_platform_sdk.models.authentication/o_auth2_user_tenant_details_dto.authentication.OAuth2UserTenantDetailsDTO( + details = [ + visier_platform_sdk.models.authentication/o_auth2_user_tenant_detail_dto.authentication.OAuth2UserTenantDetailDTO( + tenant_code = '', + display_name = '', + properties = None, ) + ], ) + ) + else: + return AuthenticationOAuth2UserInfoDTO( + ) + """ + + def testAuthenticationOAuth2UserInfoDTO(self): + """Test AuthenticationOAuth2UserInfoDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_authentication_o_auth2_user_subnet_info_dto.py b/src/visier_platform_sdk/test/test_authentication_o_auth2_user_subnet_info_dto.py new file mode 100644 index 0000000000..5a7098f355 --- /dev/null +++ b/src/visier_platform_sdk/test/test_authentication_o_auth2_user_subnet_info_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.authentication_o_auth2_user_subnet_info_dto import AuthenticationOAuth2UserSubnetInfoDTO + +class TestAuthenticationOAuth2UserSubnetInfoDTO(unittest.TestCase): + """AuthenticationOAuth2UserSubnetInfoDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AuthenticationOAuth2UserSubnetInfoDTO: + """Test AuthenticationOAuth2UserSubnetInfoDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AuthenticationOAuth2UserSubnetInfoDTO` + """ + model = AuthenticationOAuth2UserSubnetInfoDTO() + if include_optional: + return AuthenticationOAuth2UserSubnetInfoDTO( + access_type = 'Unknown', + subnets = [ + '' + ] + ) + else: + return AuthenticationOAuth2UserSubnetInfoDTO( + ) + """ + + def testAuthenticationOAuth2UserSubnetInfoDTO(self): + """Test AuthenticationOAuth2UserSubnetInfoDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_authentication_o_auth2_user_tenant_detail_dto.py b/src/visier_platform_sdk/test/test_authentication_o_auth2_user_tenant_detail_dto.py new file mode 100644 index 0000000000..b5d0321cbb --- /dev/null +++ b/src/visier_platform_sdk/test/test_authentication_o_auth2_user_tenant_detail_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_detail_dto import AuthenticationOAuth2UserTenantDetailDTO + +class TestAuthenticationOAuth2UserTenantDetailDTO(unittest.TestCase): + """AuthenticationOAuth2UserTenantDetailDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AuthenticationOAuth2UserTenantDetailDTO: + """Test AuthenticationOAuth2UserTenantDetailDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AuthenticationOAuth2UserTenantDetailDTO` + """ + model = AuthenticationOAuth2UserTenantDetailDTO() + if include_optional: + return AuthenticationOAuth2UserTenantDetailDTO( + tenant_code = '', + display_name = '', + properties = visier_platform_sdk.models.authentication/o_auth2_user_tenant_properties_dto.authentication.OAuth2UserTenantPropertiesDTO( + vanity_url_name = '', ) + ) + else: + return AuthenticationOAuth2UserTenantDetailDTO( + ) + """ + + def testAuthenticationOAuth2UserTenantDetailDTO(self): + """Test AuthenticationOAuth2UserTenantDetailDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_authentication_o_auth2_user_tenant_details_dto.py b/src/visier_platform_sdk/test/test_authentication_o_auth2_user_tenant_details_dto.py new file mode 100644 index 0000000000..8de39722ad --- /dev/null +++ b/src/visier_platform_sdk/test/test_authentication_o_auth2_user_tenant_details_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_details_dto import AuthenticationOAuth2UserTenantDetailsDTO + +class TestAuthenticationOAuth2UserTenantDetailsDTO(unittest.TestCase): + """AuthenticationOAuth2UserTenantDetailsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AuthenticationOAuth2UserTenantDetailsDTO: + """Test AuthenticationOAuth2UserTenantDetailsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AuthenticationOAuth2UserTenantDetailsDTO` + """ + model = AuthenticationOAuth2UserTenantDetailsDTO() + if include_optional: + return AuthenticationOAuth2UserTenantDetailsDTO( + details = [ + visier_platform_sdk.models.authentication/o_auth2_user_tenant_detail_dto.authentication.OAuth2UserTenantDetailDTO( + tenant_code = '', + display_name = '', + properties = None, ) + ] + ) + else: + return AuthenticationOAuth2UserTenantDetailsDTO( + ) + """ + + def testAuthenticationOAuth2UserTenantDetailsDTO(self): + """Test AuthenticationOAuth2UserTenantDetailsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_authentication_o_auth2_user_tenant_properties_dto.py b/src/visier_platform_sdk/test/test_authentication_o_auth2_user_tenant_properties_dto.py new file mode 100644 index 0000000000..7f0ae026bf --- /dev/null +++ b/src/visier_platform_sdk/test/test_authentication_o_auth2_user_tenant_properties_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_properties_dto import AuthenticationOAuth2UserTenantPropertiesDTO + +class TestAuthenticationOAuth2UserTenantPropertiesDTO(unittest.TestCase): + """AuthenticationOAuth2UserTenantPropertiesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AuthenticationOAuth2UserTenantPropertiesDTO: + """Test AuthenticationOAuth2UserTenantPropertiesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AuthenticationOAuth2UserTenantPropertiesDTO` + """ + model = AuthenticationOAuth2UserTenantPropertiesDTO() + if include_optional: + return AuthenticationOAuth2UserTenantPropertiesDTO( + vanity_url_name = '' + ) + else: + return AuthenticationOAuth2UserTenantPropertiesDTO( + ) + """ + + def testAuthenticationOAuth2UserTenantPropertiesDTO(self): + """Test AuthenticationOAuth2UserTenantPropertiesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_basic_authentication_api.py b/src/visier_platform_sdk/test/test_basic_authentication_api.py new file mode 100644 index 0000000000..322cfc0006 --- /dev/null +++ b/src/visier_platform_sdk/test/test_basic_authentication_api.py @@ -0,0 +1,46 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.basic_authentication_api import BasicAuthenticationApi + + +class TestBasicAuthenticationApi(unittest.TestCase): + """BasicAuthenticationApi unit test stubs""" + + def setUp(self) -> None: + self.api = BasicAuthenticationApi() + + def tearDown(self) -> None: + pass + + def test_a_sid_token_authentication(self) -> None: + """Test case for a_sid_token_authentication + + Request a Visier authentication token + """ + pass + + def test_generate_impersonation_token(self) -> None: + """Test case for generate_impersonation_token + + Request an impersonation token + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_benchmark_info.py b/src/visier_platform_sdk/test/test_benchmark_info.py new file mode 100644 index 0000000000..44e816a0b8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_benchmark_info.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.benchmark_info import BenchmarkInfo + +class TestBenchmarkInfo(unittest.TestCase): + """BenchmarkInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> BenchmarkInfo: + """Test BenchmarkInfo + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `BenchmarkInfo` + """ + model = BenchmarkInfo() + if include_optional: + return BenchmarkInfo( + reference_date = '', + release_date = '', + api_release_date = '' + ) + else: + return BenchmarkInfo( + reference_date = '', + release_date = '', + api_release_date = '', + ) + """ + + def testBenchmarkInfo(self): + """Test BenchmarkInfo""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_benchmark_value.py b/src/visier_platform_sdk/test/test_benchmark_value.py new file mode 100644 index 0000000000..980c06f5c3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_benchmark_value.py @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.benchmark_value import BenchmarkValue + +class TestBenchmarkValue(unittest.TestCase): + """BenchmarkValue unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> BenchmarkValue: + """Test BenchmarkValue + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `BenchmarkValue` + """ + model = BenchmarkValue() + if include_optional: + return BenchmarkValue( + percentile10 = 56, + percentile25 = 56, + percentile50 = 56, + percentile75 = 56, + percentile90 = 56, + aligned_range_min = 56, + aligned_range_max = 56, + reference_date = '', + release_date = '', + industry_id = '', + career_level_id = '' + ) + else: + return BenchmarkValue( + percentile10 = 56, + percentile25 = 56, + percentile50 = 56, + percentile75 = 56, + percentile90 = 56, + aligned_range_min = 56, + aligned_range_max = 56, + reference_date = '', + release_date = '', + industry_id = '', + career_level_id = '', + ) + """ + + def testBenchmarkValue(self): + """Test BenchmarkValue""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_benchmarks_api.py b/src/visier_platform_sdk/test/test_benchmarks_api.py new file mode 100644 index 0000000000..73a367d12c --- /dev/null +++ b/src/visier_platform_sdk/test/test_benchmarks_api.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.benchmarks_api import BenchmarksApi + + +class TestBenchmarksApi(unittest.TestCase): + """BenchmarksApi unit test stubs""" + + def setUp(self) -> None: + self.api = BenchmarksApi() + + def tearDown(self) -> None: + pass + + def test_get_info(self) -> None: + """Test case for get_info + + Get benchmark metadata + """ + pass + + def test_get_salary_benchmark(self) -> None: + """Test case for get_salary_benchmark + + Get base salary benchmark value + """ + pass + + def test_get_salary_benchmarks_in_bulk(self) -> None: + """Test case for get_salary_benchmarks_in_bulk + + Get salary benchmark values in bulk + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_concepts_v2_api.py b/src/visier_platform_sdk/test/test_concepts_v2_api.py new file mode 100644 index 0000000000..72ad1e2070 --- /dev/null +++ b/src/visier_platform_sdk/test/test_concepts_v2_api.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.concepts_v2_api import ConceptsV2Api + + +class TestConceptsV2Api(unittest.TestCase): + """ConceptsV2Api unit test stubs""" + + def setUp(self) -> None: + self.api = ConceptsV2Api() + + def tearDown(self) -> None: + pass + + def test_create_concepts(self) -> None: + """Test case for create_concepts + + Create concepts + """ + pass + + def test_delete_concepts(self) -> None: + """Test case for delete_concepts + + Delete concepts + """ + pass + + def test_get_all_concepts(self) -> None: + """Test case for get_all_concepts + + Retrieve a list of concepts + """ + pass + + def test_get_analytic_object_concepts(self) -> None: + """Test case for get_analytic_object_concepts + + Retrieve a list of concepts by analytic object + """ + pass + + def test_get_one_concept(self) -> None: + """Test case for get_one_concept + + Retrieve a concept's details + """ + pass + + def test_patch_concepts(self) -> None: + """Test case for patch_concepts + + Partially update concepts + """ + pass + + def test_put_concepts(self) -> None: + """Test case for put_concepts + + Update concepts + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_consolidated_analytics_api.py b/src/visier_platform_sdk/test/test_consolidated_analytics_api.py new file mode 100644 index 0000000000..efa9b0b160 --- /dev/null +++ b/src/visier_platform_sdk/test/test_consolidated_analytics_api.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.consolidated_analytics_api import ConsolidatedAnalyticsApi + + +class TestConsolidatedAnalyticsApi(unittest.TestCase): + """ConsolidatedAnalyticsApi unit test stubs""" + + def setUp(self) -> None: + self.api = ConsolidatedAnalyticsApi() + + def tearDown(self) -> None: + pass + + def test_add_excluded_sources(self) -> None: + """Test case for add_excluded_sources + + Add excluded sources to a consolidated analytics tenant + """ + pass + + def test_add_source_tenants(self) -> None: + """Test case for add_source_tenants + + Add source tenants to a consolidated analytics tenant + """ + pass + + def test_create_tenant(self) -> None: + """Test case for create_tenant + + Create a consolidated analytics tenant + """ + pass + + def test_list_excluded_sources(self) -> None: + """Test case for list_excluded_sources + + Retrieve a consolidated analytics tenant's excluded sources + """ + pass + + def test_list_source_tenants(self) -> None: + """Test case for list_source_tenants + + Retrieve a consolidated analytics tenant's source tenants + """ + pass + + def test_list_tenants(self) -> None: + """Test case for list_tenants + + Retrieve a list of all consolidated analytics tenants + """ + pass + + def test_list_tenants_with_details(self) -> None: + """Test case for list_tenants_with_details + + Retrieve the details of all consolidated analytics tenants + """ + pass + + def test_remove_excluded_sources(self) -> None: + """Test case for remove_excluded_sources + + Remove excluded sources from a consolidated analytics tenants + """ + pass + + def test_remove_source_tenants(self) -> None: + """Test case for remove_source_tenants + + Remove source tenants from a consolidated analytics tenants + """ + pass + + def test_set_excluded_sources(self) -> None: + """Test case for set_excluded_sources + + Set a consolidated analytics tenant's excluded sources + """ + pass + + def test_set_source_tenants(self) -> None: + """Test case for set_source_tenants + + Set a consolidated analytics tenant's source tenants + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_and_job_handling_api.py b/src/visier_platform_sdk/test/test_data_and_job_handling_api.py new file mode 100644 index 0000000000..89865c594c --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_and_job_handling_api.py @@ -0,0 +1,221 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.data_and_job_handling_api import DataAndJobHandlingApi + + +class TestDataAndJobHandlingApi(unittest.TestCase): + """DataAndJobHandlingApi unit test stubs""" + + def setUp(self) -> None: + self.api = DataAndJobHandlingApi() + + def tearDown(self) -> None: + pass + + def test_adhoc_consolidated_analytics_job(self) -> None: + """Test case for adhoc_consolidated_analytics_job + + Run a consolidated analytics job + """ + pass + + def test_adhoc_extraction_job(self) -> None: + """Test case for adhoc_extraction_job + + Run a data connector extraction job + """ + pass + + def test_adhoc_processing_jobs(self) -> None: + """Test case for adhoc_processing_jobs + + Run a processing job + """ + pass + + def test_assign_connector_credential(self) -> None: + """Test case for assign_connector_credential + + Assign connector credentials to data connectors + """ + pass + + def test_cancel_jobs(self) -> None: + """Test case for cancel_jobs + + Cancel a list of jobs + """ + pass + + def test_create_connector_credential(self) -> None: + """Test case for create_connector_credential + + Create a connector credential + """ + pass + + def test_data_connector_credentials(self) -> None: + """Test case for data_connector_credentials + + Retrieve a list of all data connector credentials + """ + pass + + def test_data_connectors(self) -> None: + """Test case for data_connectors + + Retrieve a list of all data connectors + """ + pass + + def test_delete_connector_credential(self) -> None: + """Test case for delete_connector_credential + + Delete a connector credential + """ + pass + + def test_disable_dv(self) -> None: + """Test case for disable_dv + + Disable data versions for a list of analytic tenants + """ + pass + + def test_dispatching_job_status(self) -> None: + """Test case for dispatching_job_status + + Retrieve a dispatching job's status + """ + pass + + def test_exclude_data_uplaods(self) -> None: + """Test case for exclude_data_uplaods + + Exclude data uploads + """ + pass + + def test_extraction_job_and_status(self) -> None: + """Test case for extraction_job_and_status + + Retrieve a dispatching job's extraction jobs with their statuses + """ + pass + + def test_include_data_uploads(self) -> None: + """Test case for include_data_uploads + + Include data uploads + """ + pass + + def test_job_id_status(self) -> None: + """Test case for job_id_status + + Retrieve a specific job's status + """ + pass + + def test_job_status(self) -> None: + """Test case for job_status + + Retrieve the statuses of all jobs + """ + pass + + def test_latest_enabled_dv(self) -> None: + """Test case for latest_enabled_dv + + Retrieve the latest enabled data versions for all analytic tenants + """ + pass + + def test_list_connector_settings(self) -> None: + """Test case for list_connector_settings + + Retrieve data connector settings + """ + pass + + def test_processing_job_and_status(self) -> None: + """Test case for processing_job_and_status + + Retrieve a dispatching job's processing jobs with their statuses + """ + pass + + def test_processing_job_status(self) -> None: + """Test case for processing_job_status + + Retrieve processing job statuses by receiving job ID + """ + pass + + def test_receiving_job_and_status(self) -> None: + """Test case for receiving_job_and_status + + Retrieve a dispatching job's receiving jobs with their statuses + """ + pass + + def test_receiving_job_status(self) -> None: + """Test case for receiving_job_status + + Retrieve a receiving job's status + """ + pass + + def test_retrieve_data_categories(self) -> None: + """Test case for retrieve_data_categories + + Retrieve a list of all data categories + """ + pass + + def test_retrieve_data_uploads(self) -> None: + """Test case for retrieve_data_uploads + + Retrieve data uploads + """ + pass + + def test_set_connector_setting(self) -> None: + """Test case for set_connector_setting + + Update data connector settings + """ + pass + + def test_start_extraction(self) -> None: + """Test case for start_extraction + + Trigger data connector extraction jobs + """ + pass + + def test_start_load(self) -> None: + """Test case for start_load + + Start the data load for analytic tenants + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_assign_connector_credential_request.py b/src/visier_platform_sdk/test/test_data_in_assign_connector_credential_request.py new file mode 100644 index 0000000000..b131d779f7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_assign_connector_credential_request.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_assign_connector_credential_request import DataInAssignConnectorCredentialRequest + +class TestDataInAssignConnectorCredentialRequest(unittest.TestCase): + """DataInAssignConnectorCredentialRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInAssignConnectorCredentialRequest: + """Test DataInAssignConnectorCredentialRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInAssignConnectorCredentialRequest` + """ + model = DataInAssignConnectorCredentialRequest() + if include_optional: + return DataInAssignConnectorCredentialRequest( + connectors = [ + visier_platform_sdk.models.data_in/connector.data_in.Connector( + connector_id = '', + tenants = [ + visier_platform_sdk.models.data_in/tenant_and_credential.data_in.TenantAndCredential( + tenant_code = '', + credential_id = '', ) + ], ) + ] + ) + else: + return DataInAssignConnectorCredentialRequest( + ) + """ + + def testDataInAssignConnectorCredentialRequest(self): + """Test DataInAssignConnectorCredentialRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_connector.py b/src/visier_platform_sdk/test/test_data_in_connector.py new file mode 100644 index 0000000000..9c6ea5e0f8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_connector.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_connector import DataInConnector + +class TestDataInConnector(unittest.TestCase): + """DataInConnector unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInConnector: + """Test DataInConnector + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInConnector` + """ + model = DataInConnector() + if include_optional: + return DataInConnector( + connector_id = '', + tenants = [ + visier_platform_sdk.models.data_in/tenant_and_credential.data_in.TenantAndCredential( + tenant_code = '', + credential_id = '', ) + ] + ) + else: + return DataInConnector( + ) + """ + + def testDataInConnector(self): + """Test DataInConnector""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_data_load_request.py b/src/visier_platform_sdk/test/test_data_in_data_load_request.py new file mode 100644 index 0000000000..d67b8cd62a --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_data_load_request.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_data_load_request import DataInDataLoadRequest + +class TestDataInDataLoadRequest(unittest.TestCase): + """DataInDataLoadRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInDataLoadRequest: + """Test DataInDataLoadRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInDataLoadRequest` + """ + model = DataInDataLoadRequest() + if include_optional: + return DataInDataLoadRequest( + model = visier_platform_sdk.models.data_in/data_load_request_model.data_in.DataLoadRequestModel( + files = [ + '' + ], + skip_data_load = True, ) + ) + else: + return DataInDataLoadRequest( + ) + """ + + def testDataInDataLoadRequest(self): + """Test DataInDataLoadRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_data_load_request_model.py b/src/visier_platform_sdk/test/test_data_in_data_load_request_model.py new file mode 100644 index 0000000000..7b074a404b --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_data_load_request_model.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_data_load_request_model import DataInDataLoadRequestModel + +class TestDataInDataLoadRequestModel(unittest.TestCase): + """DataInDataLoadRequestModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInDataLoadRequestModel: + """Test DataInDataLoadRequestModel + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInDataLoadRequestModel` + """ + model = DataInDataLoadRequestModel() + if include_optional: + return DataInDataLoadRequestModel( + files = [ + '' + ], + skip_data_load = True + ) + else: + return DataInDataLoadRequestModel( + ) + """ + + def testDataInDataLoadRequestModel(self): + """Test DataInDataLoadRequestModel""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_data_load_response.py b/src/visier_platform_sdk/test/test_data_in_data_load_response.py new file mode 100644 index 0000000000..eb030c8ae5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_data_load_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_data_load_response import DataInDataLoadResponse + +class TestDataInDataLoadResponse(unittest.TestCase): + """DataInDataLoadResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInDataLoadResponse: + """Test DataInDataLoadResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInDataLoadResponse` + """ + model = DataInDataLoadResponse() + if include_optional: + return DataInDataLoadResponse( + job_id = '' + ) + else: + return DataInDataLoadResponse( + ) + """ + + def testDataInDataLoadResponse(self): + """Test DataInDataLoadResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_data_transfer_result_detail.py b/src/visier_platform_sdk/test/test_data_in_data_transfer_result_detail.py new file mode 100644 index 0000000000..5070f82223 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_data_transfer_result_detail.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_data_transfer_result_detail import DataInDataTransferResultDetail + +class TestDataInDataTransferResultDetail(unittest.TestCase): + """DataInDataTransferResultDetail unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInDataTransferResultDetail: + """Test DataInDataTransferResultDetail + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInDataTransferResultDetail` + """ + model = DataInDataTransferResultDetail() + if include_optional: + return DataInDataTransferResultDetail( + tenant_code = '', + source_names = [ + '' + ], + data_size = '', + rows = '' + ) + else: + return DataInDataTransferResultDetail( + ) + """ + + def testDataInDataTransferResultDetail(self): + """Test DataInDataTransferResultDetail""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_data_version_object.py b/src/visier_platform_sdk/test/test_data_in_data_version_object.py new file mode 100644 index 0000000000..d219cf2f0a --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_data_version_object.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_data_version_object import DataInDataVersionObject + +class TestDataInDataVersionObject(unittest.TestCase): + """DataInDataVersionObject unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInDataVersionObject: + """Test DataInDataVersionObject + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInDataVersionObject` + """ + model = DataInDataVersionObject() + if include_optional: + return DataInDataVersionObject( + tenant_code = '', + data_version = '' + ) + else: + return DataInDataVersionObject( + ) + """ + + def testDataInDataVersionObject(self): + """Test DataInDataVersionObject""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_disable_dv_model.py b/src/visier_platform_sdk/test/test_data_in_disable_dv_model.py new file mode 100644 index 0000000000..ab3f7eb895 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_disable_dv_model.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_disable_dv_model import DataInDisableDVModel + +class TestDataInDisableDVModel(unittest.TestCase): + """DataInDisableDVModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInDisableDVModel: + """Test DataInDisableDVModel + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInDisableDVModel` + """ + model = DataInDisableDVModel() + if include_optional: + return DataInDisableDVModel( + data_version_objects = [ + visier_platform_sdk.models.data_in/data_version_object.data_in.DataVersionObject( + tenant_code = '', + data_version = '', ) + ] + ) + else: + return DataInDisableDVModel( + ) + """ + + def testDataInDisableDVModel(self): + """Test DataInDisableDVModel""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_disable_dv_request.py b/src/visier_platform_sdk/test/test_data_in_disable_dv_request.py new file mode 100644 index 0000000000..872b1a4a99 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_disable_dv_request.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_disable_dv_request import DataInDisableDVRequest + +class TestDataInDisableDVRequest(unittest.TestCase): + """DataInDisableDVRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInDisableDVRequest: + """Test DataInDisableDVRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInDisableDVRequest` + """ + model = DataInDisableDVRequest() + if include_optional: + return DataInDisableDVRequest( + model = visier_platform_sdk.models.data_in/disable_dv_model.data_in.DisableDVModel( + data_version_objects = [ + visier_platform_sdk.models.data_in/data_version_object.data_in.DataVersionObject( + tenant_code = '', + data_version = '', ) + ], ) + ) + else: + return DataInDisableDVRequest( + ) + """ + + def testDataInDisableDVRequest(self): + """Test DataInDisableDVRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_disable_dv_response.py b/src/visier_platform_sdk/test/test_data_in_disable_dv_response.py new file mode 100644 index 0000000000..f8ffe2fcde --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_disable_dv_response.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_disable_dv_response import DataInDisableDVResponse + +class TestDataInDisableDVResponse(unittest.TestCase): + """DataInDisableDVResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInDisableDVResponse: + """Test DataInDisableDVResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInDisableDVResponse` + """ + model = DataInDisableDVResponse() + if include_optional: + return DataInDisableDVResponse( + total_failures = 56, + total_success = 56, + results = [ + visier_platform_sdk.models.data_in/result.data_in.Result( + job_id = '', + data_version = '', + tenant_code = '', + status = '', + message = '', ) + ] + ) + else: + return DataInDisableDVResponse( + ) + """ + + def testDataInDisableDVResponse(self): + """Test DataInDisableDVResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_dispatching_job_status_response.py b/src/visier_platform_sdk/test/test_data_in_dispatching_job_status_response.py new file mode 100644 index 0000000000..f40862c4ed --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_dispatching_job_status_response.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_dispatching_job_status_response import DataInDispatchingJobStatusResponse + +class TestDataInDispatchingJobStatusResponse(unittest.TestCase): + """DataInDispatchingJobStatusResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInDispatchingJobStatusResponse: + """Test DataInDispatchingJobStatusResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInDispatchingJobStatusResponse` + """ + model = DataInDispatchingJobStatusResponse() + if include_optional: + return DataInDispatchingJobStatusResponse( + job_id = '', + tenant_code = '', + status = '', + total_jobs_dispatched = 56 + ) + else: + return DataInDispatchingJobStatusResponse( + ) + """ + + def testDataInDispatchingJobStatusResponse(self): + """Test DataInDispatchingJobStatusResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_exclude_data_uploads_request.py b/src/visier_platform_sdk/test/test_data_in_exclude_data_uploads_request.py new file mode 100644 index 0000000000..797745dd59 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_exclude_data_uploads_request.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_exclude_data_uploads_request import DataInExcludeDataUploadsRequest + +class TestDataInExcludeDataUploadsRequest(unittest.TestCase): + """DataInExcludeDataUploadsRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInExcludeDataUploadsRequest: + """Test DataInExcludeDataUploadsRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInExcludeDataUploadsRequest` + """ + model = DataInExcludeDataUploadsRequest() + if include_optional: + return DataInExcludeDataUploadsRequest( + uploads = [ + visier_platform_sdk.models.data_in/upload_to_exclude.data_in.UploadToExclude( + tenant_code = '', + exclude_all = True, + upload_times = [ + '' + ], + min_upload_time = '', + max_upload_time = '', + sources = [ + '' + ], ) + ] + ) + else: + return DataInExcludeDataUploadsRequest( + ) + """ + + def testDataInExcludeDataUploadsRequest(self): + """Test DataInExcludeDataUploadsRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_extraction_job.py b/src/visier_platform_sdk/test/test_data_in_extraction_job.py new file mode 100644 index 0000000000..8ac4fd9976 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_extraction_job.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_extraction_job import DataInExtractionJob + +class TestDataInExtractionJob(unittest.TestCase): + """DataInExtractionJob unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInExtractionJob: + """Test DataInExtractionJob + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInExtractionJob` + """ + model = DataInExtractionJob() + if include_optional: + return DataInExtractionJob( + extraction_job_id = '', + tenant_code = '', + status = '', + current_stage = '' + ) + else: + return DataInExtractionJob( + ) + """ + + def testDataInExtractionJob(self): + """Test DataInExtractionJob""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_extraction_job_and_status_response.py b/src/visier_platform_sdk/test/test_data_in_extraction_job_and_status_response.py new file mode 100644 index 0000000000..0b24368746 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_extraction_job_and_status_response.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_extraction_job_and_status_response import DataInExtractionJobAndStatusResponse + +class TestDataInExtractionJobAndStatusResponse(unittest.TestCase): + """DataInExtractionJobAndStatusResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInExtractionJobAndStatusResponse: + """Test DataInExtractionJobAndStatusResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInExtractionJobAndStatusResponse` + """ + model = DataInExtractionJobAndStatusResponse() + if include_optional: + return DataInExtractionJobAndStatusResponse( + parent_job_id = '', + parent_tenant_code = '', + limit = 56, + start = 56, + extraction_jobs = [ + visier_platform_sdk.models.data_in/extraction_job.data_in.ExtractionJob( + extraction_job_id = '', + tenant_code = '', + status = '', + current_stage = '', ) + ] + ) + else: + return DataInExtractionJobAndStatusResponse( + ) + """ + + def testDataInExtractionJobAndStatusResponse(self): + """Test DataInExtractionJobAndStatusResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_include_data_uploads_request.py b/src/visier_platform_sdk/test/test_data_in_include_data_uploads_request.py new file mode 100644 index 0000000000..94cfd7d557 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_include_data_uploads_request.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_include_data_uploads_request import DataInIncludeDataUploadsRequest + +class TestDataInIncludeDataUploadsRequest(unittest.TestCase): + """DataInIncludeDataUploadsRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInIncludeDataUploadsRequest: + """Test DataInIncludeDataUploadsRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInIncludeDataUploadsRequest` + """ + model = DataInIncludeDataUploadsRequest() + if include_optional: + return DataInIncludeDataUploadsRequest( + uploads = [ + visier_platform_sdk.models.data_in/upload_to_include.data_in.UploadToInclude( + tenant_code = '', + include_all = True, + upload_times = [ + '' + ], + min_upload_time = '', + max_upload_time = '', + sources = [ + '' + ], ) + ] + ) + else: + return DataInIncludeDataUploadsRequest( + ) + """ + + def testDataInIncludeDataUploadsRequest(self): + """Test DataInIncludeDataUploadsRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_job_status_list_response.py b/src/visier_platform_sdk/test/test_data_in_job_status_list_response.py new file mode 100644 index 0000000000..a12a44fd57 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_job_status_list_response.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_job_status_list_response import DataInJobStatusListResponse + +class TestDataInJobStatusListResponse(unittest.TestCase): + """DataInJobStatusListResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInJobStatusListResponse: + """Test DataInJobStatusListResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInJobStatusListResponse` + """ + model = DataInJobStatusListResponse() + if include_optional: + return DataInJobStatusListResponse( + query_start_time = '', + query_end_time = '', + job_status = [ + visier_platform_sdk.models.data_in/job_status_with_start_time.data_in.JobStatusWithStartTime( + job_id = '', + tenant = '', + status = '', + job_type = '', + start_time = '', ) + ] + ) + else: + return DataInJobStatusListResponse( + ) + """ + + def testDataInJobStatusListResponse(self): + """Test DataInJobStatusListResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_job_status_with_start_time.py b/src/visier_platform_sdk/test/test_data_in_job_status_with_start_time.py new file mode 100644 index 0000000000..8b0f8696e1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_job_status_with_start_time.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_job_status_with_start_time import DataInJobStatusWithStartTime + +class TestDataInJobStatusWithStartTime(unittest.TestCase): + """DataInJobStatusWithStartTime unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInJobStatusWithStartTime: + """Test DataInJobStatusWithStartTime + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInJobStatusWithStartTime` + """ + model = DataInJobStatusWithStartTime() + if include_optional: + return DataInJobStatusWithStartTime( + job_id = '', + tenant = '', + status = '', + job_type = '', + start_time = '' + ) + else: + return DataInJobStatusWithStartTime( + ) + """ + + def testDataInJobStatusWithStartTime(self): + """Test DataInJobStatusWithStartTime""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_processing_job.py b/src/visier_platform_sdk/test/test_data_in_processing_job.py new file mode 100644 index 0000000000..80d9d0eaa0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_processing_job.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_processing_job import DataInProcessingJob + +class TestDataInProcessingJob(unittest.TestCase): + """DataInProcessingJob unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInProcessingJob: + """Test DataInProcessingJob + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInProcessingJob` + """ + model = DataInProcessingJob() + if include_optional: + return DataInProcessingJob( + job_id = '', + tenant_code = '', + data_version = '', + status = '', + message = '' + ) + else: + return DataInProcessingJob( + ) + """ + + def testDataInProcessingJob(self): + """Test DataInProcessingJob""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_processing_job_and_status_response.py b/src/visier_platform_sdk/test/test_data_in_processing_job_and_status_response.py new file mode 100644 index 0000000000..cd75357cdc --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_processing_job_and_status_response.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_processing_job_and_status_response import DataInProcessingJobAndStatusResponse + +class TestDataInProcessingJobAndStatusResponse(unittest.TestCase): + """DataInProcessingJobAndStatusResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInProcessingJobAndStatusResponse: + """Test DataInProcessingJobAndStatusResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInProcessingJobAndStatusResponse` + """ + model = DataInProcessingJobAndStatusResponse() + if include_optional: + return DataInProcessingJobAndStatusResponse( + parent_job_id = '', + parent_tenant_code = '', + limit = 56, + start = 56, + processing_jobs = [ + visier_platform_sdk.models.data_in/processing_job.data_in.ProcessingJob( + job_id = '', + tenant_code = '', + data_version = '', + status = '', + message = '', ) + ] + ) + else: + return DataInProcessingJobAndStatusResponse( + ) + """ + + def testDataInProcessingJobAndStatusResponse(self): + """Test DataInProcessingJobAndStatusResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_processing_job_status_response.py b/src/visier_platform_sdk/test/test_data_in_processing_job_status_response.py new file mode 100644 index 0000000000..a244015bf5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_processing_job_status_response.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_processing_job_status_response import DataInProcessingJobStatusResponse + +class TestDataInProcessingJobStatusResponse(unittest.TestCase): + """DataInProcessingJobStatusResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInProcessingJobStatusResponse: + """Test DataInProcessingJobStatusResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInProcessingJobStatusResponse` + """ + model = DataInProcessingJobStatusResponse() + if include_optional: + return DataInProcessingJobStatusResponse( + parent_job_id = '', + parent_tenant_code = '', + limit = 56, + start = 56, + processing_jobs = [ + visier_platform_sdk.models.data_in/processing_job.data_in.ProcessingJob( + job_id = '', + tenant_code = '', + data_version = '', + status = '', + message = '', ) + ] + ) + else: + return DataInProcessingJobStatusResponse( + ) + """ + + def testDataInProcessingJobStatusResponse(self): + """Test DataInProcessingJobStatusResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_push_data_cancel_response.py b/src/visier_platform_sdk/test/test_data_in_push_data_cancel_response.py new file mode 100644 index 0000000000..3058c5a599 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_push_data_cancel_response.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_push_data_cancel_response import DataInPushDataCancelResponse + +class TestDataInPushDataCancelResponse(unittest.TestCase): + """DataInPushDataCancelResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInPushDataCancelResponse: + """Test DataInPushDataCancelResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInPushDataCancelResponse` + """ + model = DataInPushDataCancelResponse() + if include_optional: + return DataInPushDataCancelResponse( + message = '', + transfer_session_id = '', + data_transfer_result_details = [ + visier_platform_sdk.models.data_in/data_transfer_result_detail.data_in.DataTransferResultDetail( + tenant_code = '', + source_names = [ + '' + ], + data_size = '', + rows = '', ) + ], + status = '' + ) + else: + return DataInPushDataCancelResponse( + ) + """ + + def testDataInPushDataCancelResponse(self): + """Test DataInPushDataCancelResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_push_data_complete_request.py b/src/visier_platform_sdk/test/test_data_in_push_data_complete_request.py new file mode 100644 index 0000000000..c61037517c --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_push_data_complete_request.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_push_data_complete_request import DataInPushDataCompleteRequest + +class TestDataInPushDataCompleteRequest(unittest.TestCase): + """DataInPushDataCompleteRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInPushDataCompleteRequest: + """Test DataInPushDataCompleteRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInPushDataCompleteRequest` + """ + model = DataInPushDataCompleteRequest() + if include_optional: + return DataInPushDataCompleteRequest( + transfer_session_id = '', + processing_data = True + ) + else: + return DataInPushDataCompleteRequest( + ) + """ + + def testDataInPushDataCompleteRequest(self): + """Test DataInPushDataCompleteRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_push_data_complete_response.py b/src/visier_platform_sdk/test/test_data_in_push_data_complete_response.py new file mode 100644 index 0000000000..99be8887d9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_push_data_complete_response.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_push_data_complete_response import DataInPushDataCompleteResponse + +class TestDataInPushDataCompleteResponse(unittest.TestCase): + """DataInPushDataCompleteResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInPushDataCompleteResponse: + """Test DataInPushDataCompleteResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInPushDataCompleteResponse` + """ + model = DataInPushDataCompleteResponse() + if include_optional: + return DataInPushDataCompleteResponse( + data_receiving_job_id = '', + message = '', + transfer_session_id = '', + data_transfer_result_details = [ + visier_platform_sdk.models.data_in/data_transfer_result_detail.data_in.DataTransferResultDetail( + tenant_code = '', + source_names = [ + '' + ], + data_size = '', + rows = '', ) + ], + status = '' + ) + else: + return DataInPushDataCompleteResponse( + ) + """ + + def testDataInPushDataCompleteResponse(self): + """Test DataInPushDataCompleteResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_push_data_response.py b/src/visier_platform_sdk/test/test_data_in_push_data_response.py new file mode 100644 index 0000000000..94cbdcabe6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_push_data_response.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_push_data_response import DataInPushDataResponse + +class TestDataInPushDataResponse(unittest.TestCase): + """DataInPushDataResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInPushDataResponse: + """Test DataInPushDataResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInPushDataResponse` + """ + model = DataInPushDataResponse() + if include_optional: + return DataInPushDataResponse( + transfer_session_id = '', + sequence = 56, + status = '', + message = '', + tenants = [ + visier_platform_sdk.models.data_in/tenant.data_in.Tenant( + tenant_code = '', + status = '', + sources = [ + visier_platform_sdk.models.data_in/source.data_in.Source( + source_id = '', + source_name = '', + data_size = '', + rows = '', + status = '', + message = '', ) + ], ) + ] + ) + else: + return DataInPushDataResponse( + ) + """ + + def testDataInPushDataResponse(self): + """Test DataInPushDataResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_receiving_job.py b/src/visier_platform_sdk/test/test_data_in_receiving_job.py new file mode 100644 index 0000000000..0c6edde52a --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_receiving_job.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_receiving_job import DataInReceivingJob + +class TestDataInReceivingJob(unittest.TestCase): + """DataInReceivingJob unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInReceivingJob: + """Test DataInReceivingJob + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInReceivingJob` + """ + model = DataInReceivingJob() + if include_optional: + return DataInReceivingJob( + receiving_job_id = '', + tenant_code = '', + status = '' + ) + else: + return DataInReceivingJob( + ) + """ + + def testDataInReceivingJob(self): + """Test DataInReceivingJob""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_receiving_job_and_status_response.py b/src/visier_platform_sdk/test/test_data_in_receiving_job_and_status_response.py new file mode 100644 index 0000000000..4c3a0a4c34 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_receiving_job_and_status_response.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_receiving_job_and_status_response import DataInReceivingJobAndStatusResponse + +class TestDataInReceivingJobAndStatusResponse(unittest.TestCase): + """DataInReceivingJobAndStatusResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInReceivingJobAndStatusResponse: + """Test DataInReceivingJobAndStatusResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInReceivingJobAndStatusResponse` + """ + model = DataInReceivingJobAndStatusResponse() + if include_optional: + return DataInReceivingJobAndStatusResponse( + parent_job_id = '', + parent_tenant_code = '', + limit = 56, + start = 56, + receiving_jobs = [ + visier_platform_sdk.models.data_in/receiving_job.data_in.ReceivingJob( + receiving_job_id = '', + tenant_code = '', + status = '', ) + ] + ) + else: + return DataInReceivingJobAndStatusResponse( + ) + """ + + def testDataInReceivingJobAndStatusResponse(self): + """Test DataInReceivingJobAndStatusResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_receiving_job_status_response.py b/src/visier_platform_sdk/test/test_data_in_receiving_job_status_response.py new file mode 100644 index 0000000000..e0446860d0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_receiving_job_status_response.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_receiving_job_status_response import DataInReceivingJobStatusResponse + +class TestDataInReceivingJobStatusResponse(unittest.TestCase): + """DataInReceivingJobStatusResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInReceivingJobStatusResponse: + """Test DataInReceivingJobStatusResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInReceivingJobStatusResponse` + """ + model = DataInReceivingJobStatusResponse() + if include_optional: + return DataInReceivingJobStatusResponse( + job_id = '', + status = '', + parent_job_id = '', + parent_tenant_code = '', + receiving_jobs = [ + visier_platform_sdk.models.data_in/receiving_job.data_in.ReceivingJob( + receiving_job_id = '', + tenant_code = '', + status = '', ) + ] + ) + else: + return DataInReceivingJobStatusResponse( + ) + """ + + def testDataInReceivingJobStatusResponse(self): + """Test DataInReceivingJobStatusResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_result.py b/src/visier_platform_sdk/test/test_data_in_result.py new file mode 100644 index 0000000000..b659a725ce --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_result.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_result import DataInResult + +class TestDataInResult(unittest.TestCase): + """DataInResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInResult: + """Test DataInResult + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInResult` + """ + model = DataInResult() + if include_optional: + return DataInResult( + job_id = '', + data_version = '', + tenant_code = '', + status = '', + message = '' + ) + else: + return DataInResult( + ) + """ + + def testDataInResult(self): + """Test DataInResult""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_source.py b/src/visier_platform_sdk/test/test_data_in_source.py new file mode 100644 index 0000000000..7d5976fdc0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_source.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_source import DataInSource + +class TestDataInSource(unittest.TestCase): + """DataInSource unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInSource: + """Test DataInSource + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInSource` + """ + model = DataInSource() + if include_optional: + return DataInSource( + source_id = '', + source_name = '', + data_size = '', + rows = '', + status = '', + message = '' + ) + else: + return DataInSource( + ) + """ + + def testDataInSource(self): + """Test DataInSource""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_start_extraction_response.py b/src/visier_platform_sdk/test/test_data_in_start_extraction_response.py new file mode 100644 index 0000000000..538f28fa2b --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_start_extraction_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_start_extraction_response import DataInStartExtractionResponse + +class TestDataInStartExtractionResponse(unittest.TestCase): + """DataInStartExtractionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInStartExtractionResponse: + """Test DataInStartExtractionResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInStartExtractionResponse` + """ + model = DataInStartExtractionResponse() + if include_optional: + return DataInStartExtractionResponse( + job_id = '' + ) + else: + return DataInStartExtractionResponse( + ) + """ + + def testDataInStartExtractionResponse(self): + """Test DataInStartExtractionResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_start_transfer_response.py b/src/visier_platform_sdk/test/test_data_in_start_transfer_response.py new file mode 100644 index 0000000000..aef440e3f6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_start_transfer_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_start_transfer_response import DataInStartTransferResponse + +class TestDataInStartTransferResponse(unittest.TestCase): + """DataInStartTransferResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInStartTransferResponse: + """Test DataInStartTransferResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInStartTransferResponse` + """ + model = DataInStartTransferResponse() + if include_optional: + return DataInStartTransferResponse( + transfer_session_id = '' + ) + else: + return DataInStartTransferResponse( + ) + """ + + def testDataInStartTransferResponse(self): + """Test DataInStartTransferResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_tenant.py b/src/visier_platform_sdk/test/test_data_in_tenant.py new file mode 100644 index 0000000000..f0ed7977b4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_tenant.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_tenant import DataInTenant + +class TestDataInTenant(unittest.TestCase): + """DataInTenant unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInTenant: + """Test DataInTenant + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInTenant` + """ + model = DataInTenant() + if include_optional: + return DataInTenant( + tenant_code = '', + status = '', + sources = [ + visier_platform_sdk.models.data_in/source.data_in.Source( + source_id = '', + source_name = '', + data_size = '', + rows = '', + status = '', + message = '', ) + ] + ) + else: + return DataInTenant( + ) + """ + + def testDataInTenant(self): + """Test DataInTenant""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_tenant_and_credential.py b/src/visier_platform_sdk/test/test_data_in_tenant_and_credential.py new file mode 100644 index 0000000000..cafde536f5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_tenant_and_credential.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_tenant_and_credential import DataInTenantAndCredential + +class TestDataInTenantAndCredential(unittest.TestCase): + """DataInTenantAndCredential unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInTenantAndCredential: + """Test DataInTenantAndCredential + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInTenantAndCredential` + """ + model = DataInTenantAndCredential() + if include_optional: + return DataInTenantAndCredential( + tenant_code = '', + credential_id = '' + ) + else: + return DataInTenantAndCredential( + ) + """ + + def testDataInTenantAndCredential(self): + """Test DataInTenantAndCredential""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_upload_to_exclude.py b/src/visier_platform_sdk/test/test_data_in_upload_to_exclude.py new file mode 100644 index 0000000000..980e9fe27c --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_upload_to_exclude.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_upload_to_exclude import DataInUploadToExclude + +class TestDataInUploadToExclude(unittest.TestCase): + """DataInUploadToExclude unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInUploadToExclude: + """Test DataInUploadToExclude + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInUploadToExclude` + """ + model = DataInUploadToExclude() + if include_optional: + return DataInUploadToExclude( + tenant_code = '', + exclude_all = True, + upload_times = [ + '' + ], + min_upload_time = '', + max_upload_time = '', + sources = [ + '' + ] + ) + else: + return DataInUploadToExclude( + ) + """ + + def testDataInUploadToExclude(self): + """Test DataInUploadToExclude""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_in_upload_to_include.py b/src/visier_platform_sdk/test/test_data_in_upload_to_include.py new file mode 100644 index 0000000000..c32ccac523 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_in_upload_to_include.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_in_upload_to_include import DataInUploadToInclude + +class TestDataInUploadToInclude(unittest.TestCase): + """DataInUploadToInclude unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataInUploadToInclude: + """Test DataInUploadToInclude + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataInUploadToInclude` + """ + model = DataInUploadToInclude() + if include_optional: + return DataInUploadToInclude( + tenant_code = '', + include_all = True, + upload_times = [ + '' + ], + min_upload_time = '', + max_upload_time = '', + sources = [ + '' + ] + ) + else: + return DataInUploadToInclude( + ) + """ + + def testDataInUploadToInclude(self): + """Test DataInUploadToInclude""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_intake_api.py b/src/visier_platform_sdk/test/test_data_intake_api.py new file mode 100644 index 0000000000..48ab294229 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_intake_api.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.data_intake_api import DataIntakeApi + + +class TestDataIntakeApi(unittest.TestCase): + """DataIntakeApi unit test stubs""" + + def setUp(self) -> None: + self.api = DataIntakeApi() + + def tearDown(self) -> None: + pass + + def test_get_sources(self) -> None: + """Test case for get_sources + + Retrieve a list of sources + """ + pass + + def test_push_data(self) -> None: + """Test case for push_data + + Transfer data to sources via JSON + """ + pass + + def test_push_data_cancel(self) -> None: + """Test case for push_data_cancel + + Cancel a transfer session + """ + pass + + def test_push_data_complete(self) -> None: + """Test case for push_data_complete + + Complete a transfer session + """ + pass + + def test_start_transfer(self) -> None: + """Test case for start_transfer + + Start a transfer session + """ + pass + + def test_upload_data(self) -> None: + """Test case for upload_data + + Transfer data to sources via file upload + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_model_api.py b/src/visier_platform_sdk/test/test_data_model_api.py new file mode 100644 index 0000000000..5a1f2f7740 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_model_api.py @@ -0,0 +1,333 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.data_model_api import DataModelApi + + +class TestDataModelApi(unittest.TestCase): + """DataModelApi unit test stubs""" + + def setUp(self) -> None: + self.api = DataModelApi() + + def tearDown(self) -> None: + pass + + def test_analytic_metrics(self) -> None: + """Test case for analytic_metrics + + Retrieve a list of metrics for an analytic object by ID + """ + pass + + def test_analytic_object(self) -> None: + """Test case for analytic_object + + Retrieve an analytic object by ID + """ + pass + + def test_analytic_objects(self) -> None: + """Test case for analytic_objects + + Retrieve a list of analytic objects + """ + pass + + def test_call_property(self) -> None: + """Test case for call_property + + Retrieve a property by ID + """ + pass + + def test_create_properties(self) -> None: + """Test case for create_properties + + Create properties + """ + pass + + def test_create_vee_sample_questions(self) -> None: + """Test case for create_vee_sample_questions + + Add Vee sample questions + """ + pass + + def test_currencies(self) -> None: + """Test case for currencies + + Retrieve all currencies + """ + pass + + def test_currency(self) -> None: + """Test case for currency + + Retrieve a currency + """ + pass + + def test_currency_rates(self) -> None: + """Test case for currency_rates + + Retrieve all exchange rates for a currency + """ + pass + + def test_currency_rates_with_to_currency(self) -> None: + """Test case for currency_rates_with_to_currency + + Retrieve exchange rates from one currency to another currency + """ + pass + + def test_delete_properties(self) -> None: + """Test case for delete_properties + + Delete properties + """ + pass + + def test_delete_vee_sample_questions(self) -> None: + """Test case for delete_vee_sample_questions + + Delete Vee sample questions + """ + pass + + def test_dimension(self) -> None: + """Test case for dimension + + Retrieve a dimension by ID + """ + pass + + def test_dimension_member_map_validation(self) -> None: + """Test case for dimension_member_map_validation + + Validate a member map's unmapped dimension members by ID + """ + pass + + def test_dimensions(self) -> None: + """Test case for dimensions + + Retrieve a list of dimensions + """ + pass + + def test_get_vee_sample_question(self) -> None: + """Test case for get_vee_sample_question + + Retrieve a Vee sample question's details + """ + pass + + def test_get_vee_sample_question_categories(self) -> None: + """Test case for get_vee_sample_question_categories + + Retrieve a list of all Vee question categories + """ + pass + + def test_get_vee_sample_question_category(self) -> None: + """Test case for get_vee_sample_question_category + + Retrieve a Vee question category's details + """ + pass + + def test_get_vee_sample_questions(self) -> None: + """Test case for get_vee_sample_questions + + Retrieve a list of all Vee sample questions + """ + pass + + def test_member(self) -> None: + """Test case for member + + Retrieve a dimension member + """ + pass + + def test_members(self) -> None: + """Test case for members + + Retrieve a list of dimension members + """ + pass + + def test_metric(self) -> None: + """Test case for metric + + Retrieve a metric by ID + """ + pass + + def test_metric_dimensions(self) -> None: + """Test case for metric_dimensions + + Retrieve a metric's dimensions + """ + pass + + def test_metric_selection_concepts(self) -> None: + """Test case for metric_selection_concepts + + Retrieve a metric's selection concepts + """ + pass + + def test_metrics(self) -> None: + """Test case for metrics + + Retrieve a list of metrics + """ + pass + + def test_plan_data_loadl_list(self) -> None: + """Test case for plan_data_loadl_list + + Retrieve a list of plans + """ + pass + + def test_plan_info_with_schema(self) -> None: + """Test case for plan_info_with_schema + + Retrieve a plan's details + """ + pass + + def test_planning_metrics(self) -> None: + """Test case for planning_metrics + + Retrieve metrics by planning model ID + """ + pass + + def test_planning_model(self) -> None: + """Test case for planning_model + + Retrieve a planning model by ID + """ + pass + + def test_planning_models(self) -> None: + """Test case for planning_models + + Retrieve a list of planning models + """ + pass + + def test_planning_plan(self) -> None: + """Test case for planning_plan + + Retrieve a plan by planning model ID and plan ID + """ + pass + + def test_planning_plans(self) -> None: + """Test case for planning_plans + + Retrieve a list of plans by planning model ID + """ + pass + + def test_prediction(self) -> None: + """Test case for prediction + + Retrieve a prediction by ID + """ + pass + + def test_predictions(self) -> None: + """Test case for predictions + + Retrieve a list of predictions + """ + pass + + def test_properties(self) -> None: + """Test case for properties + + Retrieve a list of properties + """ + pass + + def test_put_properties(self) -> None: + """Test case for put_properties + + Replace properties + """ + pass + + def test_put_vee_sample_questions(self) -> None: + """Test case for put_vee_sample_questions + + Update Vee sample questions + """ + pass + + def test_selection_concept(self) -> None: + """Test case for selection_concept + + Retrieve an analytic object's selection concept by ID + """ + pass + + def test_selection_concepts(self) -> None: + """Test case for selection_concepts + + Retrieve an analytic object's selection concepts + """ + pass + + def test_update_analytic_objects(self) -> None: + """Test case for update_analytic_objects + + Update analytic objects + """ + pass + + def test_update_dimensions(self) -> None: + """Test case for update_dimensions + + Update dimensions + """ + pass + + def test_update_properties(self) -> None: + """Test case for update_properties + + Update properties + """ + pass + + def test_update_vee_sample_questions(self) -> None: + """Test case for update_vee_sample_questions + + Patch Vee sample questions + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_out_list_response.py b/src/visier_platform_sdk/test/test_data_out_list_response.py new file mode 100644 index 0000000000..7df6bb4fef --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_out_list_response.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.data_out_list_response import DataOutListResponse + +class TestDataOutListResponse(unittest.TestCase): + """DataOutListResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataOutListResponse: + """Test DataOutListResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataOutListResponse` + """ + model = DataOutListResponse() + if include_optional: + return DataOutListResponse( + header = { }, + rows = [ + { } + ] + ) + else: + return DataOutListResponse( + ) + """ + + def testDataOutListResponse(self): + """Test DataOutListResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_query_api.py b/src/visier_platform_sdk/test/test_data_query_api.py new file mode 100644 index 0000000000..aa7099fbb2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_query_api.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.data_query_api import DataQueryApi + + +class TestDataQueryApi(unittest.TestCase): + """DataQueryApi unit test stubs""" + + def setUp(self) -> None: + self.api = DataQueryApi() + + def tearDown(self) -> None: + pass + + def test_aggregate(self) -> None: + """Test case for aggregate + + Query aggregate data + """ + pass + + def test_list(self) -> None: + """Test case for list + + Query a list of details + """ + pass + + def test_query_snapshot(self) -> None: + """Test case for query_snapshot + + Query a series of detailed snapshots + """ + pass + + def test_sql_like(self) -> None: + """Test case for sql_like + + Query aggregate or list data using SQL-like syntax + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_upload_api.py b/src/visier_platform_sdk/test/test_data_upload_api.py new file mode 100644 index 0000000000..d181655637 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_upload_api.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.data_upload_api import DataUploadApi + + +class TestDataUploadApi(unittest.TestCase): + """DataUploadApi unit test stubs""" + + def setUp(self) -> None: + self.api = DataUploadApi() + + def tearDown(self) -> None: + pass + + def test_file_upload(self) -> None: + """Test case for file_upload + + Upload a data file to Visier + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_data_version_export_api.py b/src/visier_platform_sdk/test/test_data_version_export_api.py new file mode 100644 index 0000000000..0577a52213 --- /dev/null +++ b/src/visier_platform_sdk/test/test_data_version_export_api.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.data_version_export_api import DataVersionExportApi + + +class TestDataVersionExportApi(unittest.TestCase): + """DataVersionExportApi unit test stubs""" + + def setUp(self) -> None: + self.api = DataVersionExportApi() + + def tearDown(self) -> None: + pass + + def test_call_1_alpha_download_file(self) -> None: + """Test case for call_1_alpha_download_file + + Download a file from a data version export + """ + pass + + def test_get_available_data_versions(self) -> None: + """Test case for get_available_data_versions + + Retrieve a list of all data versions + """ + pass + + def test_get_available_exports(self) -> None: + """Test case for get_available_exports + + Retrieve the details of all data version exports + """ + pass + + def test_get_export(self) -> None: + """Test case for get_export + + Retrieve the details of a data version export + """ + pass + + def test_get_export_job_status(self) -> None: + """Test case for get_export_job_status + + Retrieve a data version export job's status + """ + pass + + def test_schedule_export_job(self) -> None: + """Test case for schedule_export_job + + Schedule a data version export job + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_common_dimension_member_reference_dto.py b/src/visier_platform_sdk/test/test_dataservices_common_dimension_member_reference_dto.py new file mode 100644 index 0000000000..a5953fc257 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_common_dimension_member_reference_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_common_dimension_member_reference_dto import DataservicesCommonDimensionMemberReferenceDTO + +class TestDataservicesCommonDimensionMemberReferenceDTO(unittest.TestCase): + """DataservicesCommonDimensionMemberReferenceDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesCommonDimensionMemberReferenceDTO: + """Test DataservicesCommonDimensionMemberReferenceDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesCommonDimensionMemberReferenceDTO` + """ + model = DataservicesCommonDimensionMemberReferenceDTO() + if include_optional: + return DataservicesCommonDimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '' + ) + else: + return DataservicesCommonDimensionMemberReferenceDTO( + ) + """ + + def testDataservicesCommonDimensionMemberReferenceDTO(self): + """Test DataservicesCommonDimensionMemberReferenceDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_common_member_values_dto.py b/src/visier_platform_sdk/test/test_dataservices_common_member_values_dto.py new file mode 100644 index 0000000000..a1ef2ed26a --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_common_member_values_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_common_member_values_dto import DataservicesCommonMemberValuesDTO + +class TestDataservicesCommonMemberValuesDTO(unittest.TestCase): + """DataservicesCommonMemberValuesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesCommonMemberValuesDTO: + """Test DataservicesCommonMemberValuesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesCommonMemberValuesDTO` + """ + model = DataservicesCommonMemberValuesDTO() + if include_optional: + return DataservicesCommonMemberValuesDTO( + included = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '', ) + ], + excluded = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '', ) + ] + ) + else: + return DataservicesCommonMemberValuesDTO( + ) + """ + + def testDataservicesCommonMemberValuesDTO(self): + """Test DataservicesCommonMemberValuesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_aggregation_type_option_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_aggregation_type_option_dto.py new file mode 100644 index 0000000000..07ae9eb525 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_aggregation_type_option_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_aggregation_type_option_dto import DataservicesDatamodelAggregationTypeOptionDTO + +class TestDataservicesDatamodelAggregationTypeOptionDTO(unittest.TestCase): + """DataservicesDatamodelAggregationTypeOptionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelAggregationTypeOptionDTO: + """Test DataservicesDatamodelAggregationTypeOptionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelAggregationTypeOptionDTO` + """ + model = DataservicesDatamodelAggregationTypeOptionDTO() + if include_optional: + return DataservicesDatamodelAggregationTypeOptionDTO( + id = '', + display_name = '', + property_name = '', + aggregation_function = '', + is_default = True + ) + else: + return DataservicesDatamodelAggregationTypeOptionDTO( + ) + """ + + def testDataservicesDatamodelAggregationTypeOptionDTO(self): + """Test DataservicesDatamodelAggregationTypeOptionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_aggregation_type_parameter_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_aggregation_type_parameter_dto.py new file mode 100644 index 0000000000..8d5ca9549f --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_aggregation_type_parameter_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_aggregation_type_parameter_dto import DataservicesDatamodelAggregationTypeParameterDTO + +class TestDataservicesDatamodelAggregationTypeParameterDTO(unittest.TestCase): + """DataservicesDatamodelAggregationTypeParameterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelAggregationTypeParameterDTO: + """Test DataservicesDatamodelAggregationTypeParameterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelAggregationTypeParameterDTO` + """ + model = DataservicesDatamodelAggregationTypeParameterDTO() + if include_optional: + return DataservicesDatamodelAggregationTypeParameterDTO( + id = '', + display_name = '', + description = '', + parameter_options = [ + visier_platform_sdk.models.dataservices/datamodel/aggregation_type_option_dto.dataservices.datamodel.AggregationTypeOptionDTO( + id = '', + display_name = '', + property_name = '', + aggregation_function = '', + is_default = True, ) + ] + ) + else: + return DataservicesDatamodelAggregationTypeParameterDTO( + ) + """ + + def testDataservicesDatamodelAggregationTypeParameterDTO(self): + """Test DataservicesDatamodelAggregationTypeParameterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_analytic_object_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_analytic_object_dto.py new file mode 100644 index 0000000000..633994ebfd --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_analytic_object_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_analytic_object_dto import DataservicesDatamodelAnalyticObjectDTO + +class TestDataservicesDatamodelAnalyticObjectDTO(unittest.TestCase): + """DataservicesDatamodelAnalyticObjectDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelAnalyticObjectDTO: + """Test DataservicesDatamodelAnalyticObjectDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelAnalyticObjectDTO` + """ + model = DataservicesDatamodelAnalyticObjectDTO() + if include_optional: + return DataservicesDatamodelAnalyticObjectDTO( + id = '', + display_name = '', + description = '', + type = 'SUBJECT', + data_start_date = '', + data_end_date = '', + property_ids = [ + '' + ], + dimension_ids = [ + '' + ], + selection_concept_ids = [ + '' + ], + object_references = [ + visier_platform_sdk.models.dataservices/datamodel/object_reference_dto.dataservices.datamodel.ObjectReferenceDTO( + id = '', + display_name = '', + description = '', + from_object = '', + to_object = '', + type = 'SUBJECT_REFERENCE', + is_strong_reference = True, ) + ], + population_configuration = visier_platform_sdk.models.dataservices/datamodel/population_configuration_dto.dataservices.datamodel.PopulationConfigurationDTO( + distinguishing_properties = [ + visier_platform_sdk.models.dataservices/datamodel/property_reference_dto.dataservices.datamodel.PropertyReferenceDTO( + name = '', + qualifying_path = '', ) + ], + change_history_properties = [ + visier_platform_sdk.models.dataservices/datamodel/property_reference_dto.dataservices.datamodel.PropertyReferenceDTO( + name = '', + qualifying_path = '', ) + ], + grouping_dimensions = [ + visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ) + ], ) + ) + else: + return DataservicesDatamodelAnalyticObjectDTO( + ) + """ + + def testDataservicesDatamodelAnalyticObjectDTO(self): + """Test DataservicesDatamodelAnalyticObjectDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_analytic_objects_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_analytic_objects_dto.py new file mode 100644 index 0000000000..f7f40238f8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_analytic_objects_dto.py @@ -0,0 +1,80 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_analytic_objects_dto import DataservicesDatamodelAnalyticObjectsDTO + +class TestDataservicesDatamodelAnalyticObjectsDTO(unittest.TestCase): + """DataservicesDatamodelAnalyticObjectsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelAnalyticObjectsDTO: + """Test DataservicesDatamodelAnalyticObjectsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelAnalyticObjectsDTO` + """ + model = DataservicesDatamodelAnalyticObjectsDTO() + if include_optional: + return DataservicesDatamodelAnalyticObjectsDTO( + analytic_objects = [ + visier_platform_sdk.models.dataservices/datamodel/analytic_object_dto.dataservices.datamodel.AnalyticObjectDTO( + id = '', + display_name = '', + description = '', + type = 'SUBJECT', + data_start_date = '', + data_end_date = '', + property_ids = [ + '' + ], + dimension_ids = [ + '' + ], + selection_concept_ids = [ + '' + ], + object_references = [ + visier_platform_sdk.models.dataservices/datamodel/object_reference_dto.dataservices.datamodel.ObjectReferenceDTO( + id = '', + display_name = '', + description = '', + from_object = '', + to_object = '', + type = 'SUBJECT_REFERENCE', + is_strong_reference = True, ) + ], + population_configuration = None, ) + ] + ) + else: + return DataservicesDatamodelAnalyticObjectsDTO( + ) + """ + + def testDataservicesDatamodelAnalyticObjectsDTO(self): + """Test DataservicesDatamodelAnalyticObjectsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_currencies_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_currencies_dto.py new file mode 100644 index 0000000000..9b51320015 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_currencies_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_currencies_dto import DataservicesDatamodelCurrenciesDTO + +class TestDataservicesDatamodelCurrenciesDTO(unittest.TestCase): + """DataservicesDatamodelCurrenciesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelCurrenciesDTO: + """Test DataservicesDatamodelCurrenciesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelCurrenciesDTO` + """ + model = DataservicesDatamodelCurrenciesDTO() + if include_optional: + return DataservicesDatamodelCurrenciesDTO( + currencies = [ + visier_platform_sdk.models.dataservices/datamodel/currency_dto.dataservices.datamodel.CurrencyDTO( + currency_code = '', + display_name = '', + symbol = '', + short_symbol = '', ) + ] + ) + else: + return DataservicesDatamodelCurrenciesDTO( + ) + """ + + def testDataservicesDatamodelCurrenciesDTO(self): + """Test DataservicesDatamodelCurrenciesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_currency_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_currency_dto.py new file mode 100644 index 0000000000..9186e04985 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_currency_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_currency_dto import DataservicesDatamodelCurrencyDTO + +class TestDataservicesDatamodelCurrencyDTO(unittest.TestCase): + """DataservicesDatamodelCurrencyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelCurrencyDTO: + """Test DataservicesDatamodelCurrencyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelCurrencyDTO` + """ + model = DataservicesDatamodelCurrencyDTO() + if include_optional: + return DataservicesDatamodelCurrencyDTO( + currency_code = '', + display_name = '', + symbol = '', + short_symbol = '' + ) + else: + return DataservicesDatamodelCurrencyDTO( + ) + """ + + def testDataservicesDatamodelCurrencyDTO(self): + """Test DataservicesDatamodelCurrencyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_currency_rate_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_currency_rate_dto.py new file mode 100644 index 0000000000..5f713bc8bd --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_currency_rate_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_currency_rate_dto import DataservicesDatamodelCurrencyRateDTO + +class TestDataservicesDatamodelCurrencyRateDTO(unittest.TestCase): + """DataservicesDatamodelCurrencyRateDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelCurrencyRateDTO: + """Test DataservicesDatamodelCurrencyRateDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelCurrencyRateDTO` + """ + model = DataservicesDatamodelCurrencyRateDTO() + if include_optional: + return DataservicesDatamodelCurrencyRateDTO( + from_currency_code = '', + to_currency_code = '', + rate = 1.337, + start_time = '', + end_time = '' + ) + else: + return DataservicesDatamodelCurrencyRateDTO( + ) + """ + + def testDataservicesDatamodelCurrencyRateDTO(self): + """Test DataservicesDatamodelCurrencyRateDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_currency_rates_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_currency_rates_dto.py new file mode 100644 index 0000000000..edd45abd7d --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_currency_rates_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_currency_rates_dto import DataservicesDatamodelCurrencyRatesDTO + +class TestDataservicesDatamodelCurrencyRatesDTO(unittest.TestCase): + """DataservicesDatamodelCurrencyRatesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelCurrencyRatesDTO: + """Test DataservicesDatamodelCurrencyRatesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelCurrencyRatesDTO` + """ + model = DataservicesDatamodelCurrencyRatesDTO() + if include_optional: + return DataservicesDatamodelCurrencyRatesDTO( + currency_rates = [ + visier_platform_sdk.models.dataservices/datamodel/currency_rate_dto.dataservices.datamodel.CurrencyRateDTO( + from_currency_code = '', + to_currency_code = '', + rate = 1.337, + start_time = '', + end_time = '', ) + ] + ) + else: + return DataservicesDatamodelCurrencyRatesDTO( + ) + """ + + def testDataservicesDatamodelCurrencyRatesDTO(self): + """Test DataservicesDatamodelCurrencyRatesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_dto.py new file mode 100644 index 0000000000..12f5072fd2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_dto.py @@ -0,0 +1,71 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_dimension_dto import DataservicesDatamodelDimensionDTO + +class TestDataservicesDatamodelDimensionDTO(unittest.TestCase): + """DataservicesDatamodelDimensionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelDimensionDTO: + """Test DataservicesDatamodelDimensionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelDimensionDTO` + """ + model = DataservicesDatamodelDimensionDTO() + if include_optional: + return DataservicesDatamodelDimensionDTO( + id = '', + display_name = '', + description = '', + levels = [ + visier_platform_sdk.models.dataservices/datamodel/level_dto.dataservices.datamodel.LevelDTO( + id = '', + display_name = '', + depth = 56, ) + ], + unknown_member = [ + '' + ], + member_count = 56, + visible_in_app = True, + tags = [ + visier_platform_sdk.models.dataservices/datamodel/tag_map_element_dto.dataservices.datamodel.TagMapElementDTO( + id = '', + display_name = '', ) + ], + explanation = '' + ) + else: + return DataservicesDatamodelDimensionDTO( + ) + """ + + def testDataservicesDatamodelDimensionDTO(self): + """Test DataservicesDatamodelDimensionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_mapping_validation_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_mapping_validation_dto.py new file mode 100644 index 0000000000..a1ebb53ae7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_mapping_validation_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_dimension_mapping_validation_dto import DataservicesDatamodelDimensionMappingValidationDTO + +class TestDataservicesDatamodelDimensionMappingValidationDTO(unittest.TestCase): + """DataservicesDatamodelDimensionMappingValidationDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelDimensionMappingValidationDTO: + """Test DataservicesDatamodelDimensionMappingValidationDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelDimensionMappingValidationDTO` + """ + model = DataservicesDatamodelDimensionMappingValidationDTO() + if include_optional: + return DataservicesDatamodelDimensionMappingValidationDTO( + dimension_map_id = '', + dimension_id = '', + unmapped_members = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '', ) + ], + failures = [ + '' + ] + ) + else: + return DataservicesDatamodelDimensionMappingValidationDTO( + ) + """ + + def testDataservicesDatamodelDimensionMappingValidationDTO(self): + """Test DataservicesDatamodelDimensionMappingValidationDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_mapping_validation_execution_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_mapping_validation_execution_dto.py new file mode 100644 index 0000000000..ebd6c1a7d5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_mapping_validation_execution_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_dimension_mapping_validation_execution_dto import DataservicesDatamodelDimensionMappingValidationExecutionDTO + +class TestDataservicesDatamodelDimensionMappingValidationExecutionDTO(unittest.TestCase): + """DataservicesDatamodelDimensionMappingValidationExecutionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelDimensionMappingValidationExecutionDTO: + """Test DataservicesDatamodelDimensionMappingValidationExecutionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelDimensionMappingValidationExecutionDTO` + """ + model = DataservicesDatamodelDimensionMappingValidationExecutionDTO() + if include_optional: + return DataservicesDatamodelDimensionMappingValidationExecutionDTO( + member_map_id = '', + analytic_object = '' + ) + else: + return DataservicesDatamodelDimensionMappingValidationExecutionDTO( + ) + """ + + def testDataservicesDatamodelDimensionMappingValidationExecutionDTO(self): + """Test DataservicesDatamodelDimensionMappingValidationExecutionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_reference_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_reference_dto.py new file mode 100644 index 0000000000..d8e29bd14f --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_dimension_reference_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO + +class TestDataservicesDatamodelDimensionReferenceDTO(unittest.TestCase): + """DataservicesDatamodelDimensionReferenceDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelDimensionReferenceDTO: + """Test DataservicesDatamodelDimensionReferenceDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelDimensionReferenceDTO` + """ + model = DataservicesDatamodelDimensionReferenceDTO() + if include_optional: + return DataservicesDatamodelDimensionReferenceDTO( + name = '', + qualifying_path = '' + ) + else: + return DataservicesDatamodelDimensionReferenceDTO( + ) + """ + + def testDataservicesDatamodelDimensionReferenceDTO(self): + """Test DataservicesDatamodelDimensionReferenceDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_dimensions_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_dimensions_dto.py new file mode 100644 index 0000000000..f388481916 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_dimensions_dto.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_dimensions_dto import DataservicesDatamodelDimensionsDTO + +class TestDataservicesDatamodelDimensionsDTO(unittest.TestCase): + """DataservicesDatamodelDimensionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelDimensionsDTO: + """Test DataservicesDatamodelDimensionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelDimensionsDTO` + """ + model = DataservicesDatamodelDimensionsDTO() + if include_optional: + return DataservicesDatamodelDimensionsDTO( + dimensions = [ + visier_platform_sdk.models.dataservices/datamodel/dimension_dto.dataservices.datamodel.DimensionDTO( + id = '', + display_name = '', + description = '', + levels = [ + visier_platform_sdk.models.dataservices/datamodel/level_dto.dataservices.datamodel.LevelDTO( + id = '', + display_name = '', + depth = 56, ) + ], + unknown_member = [ + '' + ], + member_count = 56, + visible_in_app = True, + tags = [ + visier_platform_sdk.models.dataservices/datamodel/tag_map_element_dto.dataservices.datamodel.TagMapElementDTO( + id = '', + display_name = '', ) + ], + explanation = '', ) + ] + ) + else: + return DataservicesDatamodelDimensionsDTO( + ) + """ + + def testDataservicesDatamodelDimensionsDTO(self): + """Test DataservicesDatamodelDimensionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_level_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_level_dto.py new file mode 100644 index 0000000000..09c28b952f --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_level_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_level_dto import DataservicesDatamodelLevelDTO + +class TestDataservicesDatamodelLevelDTO(unittest.TestCase): + """DataservicesDatamodelLevelDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelLevelDTO: + """Test DataservicesDatamodelLevelDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelLevelDTO` + """ + model = DataservicesDatamodelLevelDTO() + if include_optional: + return DataservicesDatamodelLevelDTO( + id = '', + display_name = '', + depth = 56 + ) + else: + return DataservicesDatamodelLevelDTO( + ) + """ + + def testDataservicesDatamodelLevelDTO(self): + """Test DataservicesDatamodelLevelDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_member_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_member_dto.py new file mode 100644 index 0000000000..bd523eec98 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_member_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_member_dto import DataservicesDatamodelMemberDTO + +class TestDataservicesDatamodelMemberDTO(unittest.TestCase): + """DataservicesDatamodelMemberDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelMemberDTO: + """Test DataservicesDatamodelMemberDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelMemberDTO` + """ + model = DataservicesDatamodelMemberDTO() + if include_optional: + return DataservicesDatamodelMemberDTO( + full_name = '', + display_name = '', + level = 56, + path = [ + '' + ], + validity_ranges = [ + visier_platform_sdk.models.dataservices/datamodel/validity_range_dto.dataservices.datamodel.ValidityRangeDTO( + start = '', + end = '', ) + ], + display_name_path = [ + '' + ] + ) + else: + return DataservicesDatamodelMemberDTO( + ) + """ + + def testDataservicesDatamodelMemberDTO(self): + """Test DataservicesDatamodelMemberDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_member_parameter_definition_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_member_parameter_definition_dto.py new file mode 100644 index 0000000000..3b233164d8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_member_parameter_definition_dto.py @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_member_parameter_definition_dto import DataservicesDatamodelMemberParameterDefinitionDTO + +class TestDataservicesDatamodelMemberParameterDefinitionDTO(unittest.TestCase): + """DataservicesDatamodelMemberParameterDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelMemberParameterDefinitionDTO: + """Test DataservicesDatamodelMemberParameterDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelMemberParameterDefinitionDTO` + """ + model = DataservicesDatamodelMemberParameterDefinitionDTO() + if include_optional: + return DataservicesDatamodelMemberParameterDefinitionDTO( + id = '', + display_name = '', + description = '', + dimension_id = '', + reference_path = [ + '' + ], + default = visier_platform_sdk.models.dataservices/common/member_values_dto.dataservices.common.MemberValuesDTO( + included = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '', ) + ], + excluded = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + member_id = '', ) + ], ) + ) + else: + return DataservicesDatamodelMemberParameterDefinitionDTO( + ) + """ + + def testDataservicesDatamodelMemberParameterDefinitionDTO(self): + """Test DataservicesDatamodelMemberParameterDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_members_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_members_dto.py new file mode 100644 index 0000000000..ab7c78d995 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_members_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_members_dto import DataservicesDatamodelMembersDTO + +class TestDataservicesDatamodelMembersDTO(unittest.TestCase): + """DataservicesDatamodelMembersDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelMembersDTO: + """Test DataservicesDatamodelMembersDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelMembersDTO` + """ + model = DataservicesDatamodelMembersDTO() + if include_optional: + return DataservicesDatamodelMembersDTO( + members = [ + visier_platform_sdk.models.dataservices/datamodel/member_dto.dataservices.datamodel.MemberDTO( + full_name = '', + display_name = '', + level = 56, + path = [ + '' + ], + validity_ranges = [ + visier_platform_sdk.models.dataservices/datamodel/validity_range_dto.dataservices.datamodel.ValidityRangeDTO( + start = '', + end = '', ) + ], + display_name_path = [ + '' + ], ) + ] + ) + else: + return DataservicesDatamodelMembersDTO( + ) + """ + + def testDataservicesDatamodelMembersDTO(self): + """Test DataservicesDatamodelMembersDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_metric_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_metric_dto.py new file mode 100644 index 0000000000..76aaf41ba5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_metric_dto.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_metric_dto import DataservicesDatamodelMetricDTO + +class TestDataservicesDatamodelMetricDTO(unittest.TestCase): + """DataservicesDatamodelMetricDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelMetricDTO: + """Test DataservicesDatamodelMetricDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelMetricDTO` + """ + model = DataservicesDatamodelMetricDTO() + if include_optional: + return DataservicesDatamodelMetricDTO( + id = '', + display_name = '', + description = '', + data_start_date = '', + data_end_date = '', + analytic_object_id = '', + parameters = [ + visier_platform_sdk.models.dataservices/datamodel/parameter_definition_dto.dataservices.datamodel.ParameterDefinitionDTO( + member_parameter = None, + numeric_parameter = None, + plan_parameter = None, + aggregation_type_parameter = None, ) + ], + category = 'REGULAR', + visible_in_app = True + ) + else: + return DataservicesDatamodelMetricDTO( + ) + """ + + def testDataservicesDatamodelMetricDTO(self): + """Test DataservicesDatamodelMetricDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_metrics_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_metrics_dto.py new file mode 100644 index 0000000000..ae7b23ec74 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_metrics_dto.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_metrics_dto import DataservicesDatamodelMetricsDTO + +class TestDataservicesDatamodelMetricsDTO(unittest.TestCase): + """DataservicesDatamodelMetricsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelMetricsDTO: + """Test DataservicesDatamodelMetricsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelMetricsDTO` + """ + model = DataservicesDatamodelMetricsDTO() + if include_optional: + return DataservicesDatamodelMetricsDTO( + metrics = [ + visier_platform_sdk.models.dataservices/datamodel/metric_dto.dataservices.datamodel.MetricDTO( + id = '', + display_name = '', + description = '', + data_start_date = '', + data_end_date = '', + analytic_object_id = '', + parameters = [ + visier_platform_sdk.models.dataservices/datamodel/parameter_definition_dto.dataservices.datamodel.ParameterDefinitionDTO( + member_parameter = None, + numeric_parameter = None, + plan_parameter = None, + aggregation_type_parameter = None, ) + ], + category = 'REGULAR', + visible_in_app = True, ) + ] + ) + else: + return DataservicesDatamodelMetricsDTO( + ) + """ + + def testDataservicesDatamodelMetricsDTO(self): + """Test DataservicesDatamodelMetricsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_numeric_parameter_definition_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_numeric_parameter_definition_dto.py new file mode 100644 index 0000000000..fd0471d05c --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_numeric_parameter_definition_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_numeric_parameter_definition_dto import DataservicesDatamodelNumericParameterDefinitionDTO + +class TestDataservicesDatamodelNumericParameterDefinitionDTO(unittest.TestCase): + """DataservicesDatamodelNumericParameterDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelNumericParameterDefinitionDTO: + """Test DataservicesDatamodelNumericParameterDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelNumericParameterDefinitionDTO` + """ + model = DataservicesDatamodelNumericParameterDefinitionDTO() + if include_optional: + return DataservicesDatamodelNumericParameterDefinitionDTO( + id = '', + display_name = '', + description = '', + lower_bound = 1.337, + upper_bound = 1.337, + default = 1.337 + ) + else: + return DataservicesDatamodelNumericParameterDefinitionDTO( + ) + """ + + def testDataservicesDatamodelNumericParameterDefinitionDTO(self): + """Test DataservicesDatamodelNumericParameterDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_object_reference_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_object_reference_dto.py new file mode 100644 index 0000000000..6cc977f88f --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_object_reference_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_object_reference_dto import DataservicesDatamodelObjectReferenceDTO + +class TestDataservicesDatamodelObjectReferenceDTO(unittest.TestCase): + """DataservicesDatamodelObjectReferenceDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelObjectReferenceDTO: + """Test DataservicesDatamodelObjectReferenceDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelObjectReferenceDTO` + """ + model = DataservicesDatamodelObjectReferenceDTO() + if include_optional: + return DataservicesDatamodelObjectReferenceDTO( + id = '', + display_name = '', + description = '', + from_object = '', + to_object = '', + type = 'SUBJECT_REFERENCE', + is_strong_reference = True + ) + else: + return DataservicesDatamodelObjectReferenceDTO( + ) + """ + + def testDataservicesDatamodelObjectReferenceDTO(self): + """Test DataservicesDatamodelObjectReferenceDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_parameter_definition_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_parameter_definition_dto.py new file mode 100644 index 0000000000..53584853c3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_parameter_definition_dto.py @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_parameter_definition_dto import DataservicesDatamodelParameterDefinitionDTO + +class TestDataservicesDatamodelParameterDefinitionDTO(unittest.TestCase): + """DataservicesDatamodelParameterDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelParameterDefinitionDTO: + """Test DataservicesDatamodelParameterDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelParameterDefinitionDTO` + """ + model = DataservicesDatamodelParameterDefinitionDTO() + if include_optional: + return DataservicesDatamodelParameterDefinitionDTO( + member_parameter = visier_platform_sdk.models.dataservices/datamodel/member_parameter_definition_dto.dataservices.datamodel.MemberParameterDefinitionDTO( + id = '', + display_name = '', + description = '', + dimension_id = '', + reference_path = [ + '' + ], + default = None, ), + numeric_parameter = visier_platform_sdk.models.dataservices/datamodel/numeric_parameter_definition_dto.dataservices.datamodel.NumericParameterDefinitionDTO( + id = '', + display_name = '', + description = '', + lower_bound = 1.337, + upper_bound = 1.337, + default = 1.337, ), + plan_parameter = visier_platform_sdk.models.dataservices/datamodel/plan_parameter_definition_dto.dataservices.datamodel.PlanParameterDefinitionDTO( + id = '', + display_name = '', + description = '', + model_name = '', ), + aggregation_type_parameter = visier_platform_sdk.models.dataservices/datamodel/aggregation_type_parameter_dto.dataservices.datamodel.AggregationTypeParameterDTO( + id = '', + display_name = '', + description = '', + parameter_options = [ + visier_platform_sdk.models.dataservices/datamodel/aggregation_type_option_dto.dataservices.datamodel.AggregationTypeOptionDTO( + id = '', + display_name = '', + property_name = '', + aggregation_function = '', + is_default = True, ) + ], ) + ) + else: + return DataservicesDatamodelParameterDefinitionDTO( + ) + """ + + def testDataservicesDatamodelParameterDefinitionDTO(self): + """Test DataservicesDatamodelParameterDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_plan_parameter_definition_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_plan_parameter_definition_dto.py new file mode 100644 index 0000000000..5fbdc8e4ab --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_plan_parameter_definition_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_plan_parameter_definition_dto import DataservicesDatamodelPlanParameterDefinitionDTO + +class TestDataservicesDatamodelPlanParameterDefinitionDTO(unittest.TestCase): + """DataservicesDatamodelPlanParameterDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPlanParameterDefinitionDTO: + """Test DataservicesDatamodelPlanParameterDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPlanParameterDefinitionDTO` + """ + model = DataservicesDatamodelPlanParameterDefinitionDTO() + if include_optional: + return DataservicesDatamodelPlanParameterDefinitionDTO( + id = '', + display_name = '', + description = '', + model_name = '' + ) + else: + return DataservicesDatamodelPlanParameterDefinitionDTO( + ) + """ + + def testDataservicesDatamodelPlanParameterDefinitionDTO(self): + """Test DataservicesDatamodelPlanParameterDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_concept_filter_context_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_concept_filter_context_dto.py new file mode 100644 index 0000000000..4636fb8d89 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_concept_filter_context_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_planning_concept_filter_context_dto import DataservicesDatamodelPlanningConceptFilterContextDTO + +class TestDataservicesDatamodelPlanningConceptFilterContextDTO(unittest.TestCase): + """DataservicesDatamodelPlanningConceptFilterContextDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPlanningConceptFilterContextDTO: + """Test DataservicesDatamodelPlanningConceptFilterContextDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPlanningConceptFilterContextDTO` + """ + model = DataservicesDatamodelPlanningConceptFilterContextDTO() + if include_optional: + return DataservicesDatamodelPlanningConceptFilterContextDTO( + name = '' + ) + else: + return DataservicesDatamodelPlanningConceptFilterContextDTO( + ) + """ + + def testDataservicesDatamodelPlanningConceptFilterContextDTO(self): + """Test DataservicesDatamodelPlanningConceptFilterContextDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_hierarchy_filter_context_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_hierarchy_filter_context_dto.py new file mode 100644 index 0000000000..1c05388d67 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_hierarchy_filter_context_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_planning_hierarchy_filter_context_dto import DataservicesDatamodelPlanningHierarchyFilterContextDTO + +class TestDataservicesDatamodelPlanningHierarchyFilterContextDTO(unittest.TestCase): + """DataservicesDatamodelPlanningHierarchyFilterContextDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPlanningHierarchyFilterContextDTO: + """Test DataservicesDatamodelPlanningHierarchyFilterContextDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPlanningHierarchyFilterContextDTO` + """ + model = DataservicesDatamodelPlanningHierarchyFilterContextDTO() + if include_optional: + return DataservicesDatamodelPlanningHierarchyFilterContextDTO( + hierarchy_name = '', + included_members = [ + '' + ], + excluded_members = [ + '' + ] + ) + else: + return DataservicesDatamodelPlanningHierarchyFilterContextDTO( + ) + """ + + def testDataservicesDatamodelPlanningHierarchyFilterContextDTO(self): + """Test DataservicesDatamodelPlanningHierarchyFilterContextDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_model_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_model_dto.py new file mode 100644 index 0000000000..1be3e11872 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_model_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_planning_model_dto import DataservicesDatamodelPlanningModelDTO + +class TestDataservicesDatamodelPlanningModelDTO(unittest.TestCase): + """DataservicesDatamodelPlanningModelDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPlanningModelDTO: + """Test DataservicesDatamodelPlanningModelDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPlanningModelDTO` + """ + model = DataservicesDatamodelPlanningModelDTO() + if include_optional: + return DataservicesDatamodelPlanningModelDTO( + id = '', + display_name = '', + description = '' + ) + else: + return DataservicesDatamodelPlanningModelDTO( + ) + """ + + def testDataservicesDatamodelPlanningModelDTO(self): + """Test DataservicesDatamodelPlanningModelDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_models_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_models_dto.py new file mode 100644 index 0000000000..87cb52afa5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_models_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_planning_models_dto import DataservicesDatamodelPlanningModelsDTO + +class TestDataservicesDatamodelPlanningModelsDTO(unittest.TestCase): + """DataservicesDatamodelPlanningModelsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPlanningModelsDTO: + """Test DataservicesDatamodelPlanningModelsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPlanningModelsDTO` + """ + model = DataservicesDatamodelPlanningModelsDTO() + if include_optional: + return DataservicesDatamodelPlanningModelsDTO( + models = [ + visier_platform_sdk.models.dataservices/datamodel/planning_model_dto.dataservices.datamodel.PlanningModelDTO( + id = '', + display_name = '', + description = '', ) + ] + ) + else: + return DataservicesDatamodelPlanningModelsDTO( + ) + """ + + def testDataservicesDatamodelPlanningModelsDTO(self): + """Test DataservicesDatamodelPlanningModelsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_plan_context_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_plan_context_dto.py new file mode 100644 index 0000000000..76dc0b7e89 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_plan_context_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_planning_plan_context_dto import DataservicesDatamodelPlanningPlanContextDTO + +class TestDataservicesDatamodelPlanningPlanContextDTO(unittest.TestCase): + """DataservicesDatamodelPlanningPlanContextDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPlanningPlanContextDTO: + """Test DataservicesDatamodelPlanningPlanContextDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPlanningPlanContextDTO` + """ + model = DataservicesDatamodelPlanningPlanContextDTO() + if include_optional: + return DataservicesDatamodelPlanningPlanContextDTO( + hierarchy_filter_context = visier_platform_sdk.models.dataservices/datamodel/planning_hierarchy_filter_context_dto.dataservices.datamodel.PlanningHierarchyFilterContextDTO( + hierarchy_name = '', + included_members = [ + '' + ], + excluded_members = [ + '' + ], ), + concept_filter_context = visier_platform_sdk.models.dataservices/datamodel/planning_concept_filter_context_dto.dataservices.datamodel.PlanningConceptFilterContextDTO( + name = '', ) + ) + else: + return DataservicesDatamodelPlanningPlanContextDTO( + ) + """ + + def testDataservicesDatamodelPlanningPlanContextDTO(self): + """Test DataservicesDatamodelPlanningPlanContextDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_plan_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_plan_dto.py new file mode 100644 index 0000000000..55dd631f70 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_plan_dto.py @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_planning_plan_dto import DataservicesDatamodelPlanningPlanDTO + +class TestDataservicesDatamodelPlanningPlanDTO(unittest.TestCase): + """DataservicesDatamodelPlanningPlanDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPlanningPlanDTO: + """Test DataservicesDatamodelPlanningPlanDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPlanningPlanDTO` + """ + model = DataservicesDatamodelPlanningPlanDTO() + if include_optional: + return DataservicesDatamodelPlanningPlanDTO( + id = '', + name = '', + subject_id = '', + default_contexts = [ + visier_platform_sdk.models.dataservices/datamodel/planning_plan_context_dto.dataservices.datamodel.PlanningPlanContextDTO( + hierarchy_filter_context = None, + concept_filter_context = None, ) + ], + plan_dimension_ids = [ + '' + ], + scenarios = [ + visier_platform_sdk.models.dataservices/datamodel/scenario_or_snapshot_dto.dataservices.datamodel.ScenarioOrSnapshotDTO( + id = '', + display_name = '', ) + ], + snapshots = [ + visier_platform_sdk.models.dataservices/datamodel/scenario_or_snapshot_dto.dataservices.datamodel.ScenarioOrSnapshotDTO( + id = '', + display_name = '', ) + ] + ) + else: + return DataservicesDatamodelPlanningPlanDTO( + ) + """ + + def testDataservicesDatamodelPlanningPlanDTO(self): + """Test DataservicesDatamodelPlanningPlanDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_plans_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_plans_dto.py new file mode 100644 index 0000000000..5b75cae203 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_planning_plans_dto.py @@ -0,0 +1,75 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_planning_plans_dto import DataservicesDatamodelPlanningPlansDTO + +class TestDataservicesDatamodelPlanningPlansDTO(unittest.TestCase): + """DataservicesDatamodelPlanningPlansDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPlanningPlansDTO: + """Test DataservicesDatamodelPlanningPlansDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPlanningPlansDTO` + """ + model = DataservicesDatamodelPlanningPlansDTO() + if include_optional: + return DataservicesDatamodelPlanningPlansDTO( + plans = [ + visier_platform_sdk.models.dataservices/datamodel/planning_plan_dto.dataservices.datamodel.PlanningPlanDTO( + id = '', + name = '', + subject_id = '', + default_contexts = [ + visier_platform_sdk.models.dataservices/datamodel/planning_plan_context_dto.dataservices.datamodel.PlanningPlanContextDTO( + hierarchy_filter_context = None, + concept_filter_context = None, ) + ], + plan_dimension_ids = [ + '' + ], + scenarios = [ + visier_platform_sdk.models.dataservices/datamodel/scenario_or_snapshot_dto.dataservices.datamodel.ScenarioOrSnapshotDTO( + id = '', + display_name = '', ) + ], + snapshots = [ + visier_platform_sdk.models.dataservices/datamodel/scenario_or_snapshot_dto.dataservices.datamodel.ScenarioOrSnapshotDTO( + id = '', + display_name = '', ) + ], ) + ] + ) + else: + return DataservicesDatamodelPlanningPlansDTO( + ) + """ + + def testDataservicesDatamodelPlanningPlansDTO(self): + """Test DataservicesDatamodelPlanningPlansDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_population_configuration_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_population_configuration_dto.py new file mode 100644 index 0000000000..c79ff507f3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_population_configuration_dto.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_population_configuration_dto import DataservicesDatamodelPopulationConfigurationDTO + +class TestDataservicesDatamodelPopulationConfigurationDTO(unittest.TestCase): + """DataservicesDatamodelPopulationConfigurationDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPopulationConfigurationDTO: + """Test DataservicesDatamodelPopulationConfigurationDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPopulationConfigurationDTO` + """ + model = DataservicesDatamodelPopulationConfigurationDTO() + if include_optional: + return DataservicesDatamodelPopulationConfigurationDTO( + distinguishing_properties = [ + visier_platform_sdk.models.dataservices/datamodel/property_reference_dto.dataservices.datamodel.PropertyReferenceDTO( + name = '', + qualifying_path = '', ) + ], + change_history_properties = [ + visier_platform_sdk.models.dataservices/datamodel/property_reference_dto.dataservices.datamodel.PropertyReferenceDTO( + name = '', + qualifying_path = '', ) + ], + grouping_dimensions = [ + visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ) + ] + ) + else: + return DataservicesDatamodelPopulationConfigurationDTO( + ) + """ + + def testDataservicesDatamodelPopulationConfigurationDTO(self): + """Test DataservicesDatamodelPopulationConfigurationDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_prediction_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_prediction_dto.py new file mode 100644 index 0000000000..3cbbf358b3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_prediction_dto.py @@ -0,0 +1,76 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_prediction_dto import DataservicesDatamodelPredictionDTO + +class TestDataservicesDatamodelPredictionDTO(unittest.TestCase): + """DataservicesDatamodelPredictionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPredictionDTO: + """Test DataservicesDatamodelPredictionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPredictionDTO` + """ + model = DataservicesDatamodelPredictionDTO() + if include_optional: + return DataservicesDatamodelPredictionDTO( + id = '', + display_name = '', + description = '', + subject = '', + subject_key = '', + subject_parent_key = '', + subject_filter = '', + event = '', + event_filter = '', + label_property = '', + factor_properties = [ + '' + ], + factor_dimensions = [ + '' + ], + factor_concepts = [ + '' + ], + data_start_date = '', + data_end_date = '', + score_name = '', + factors_name = '', + minimum_training_months = '', + is_multi_tenant = True + ) + else: + return DataservicesDatamodelPredictionDTO( + ) + """ + + def testDataservicesDatamodelPredictionDTO(self): + """Test DataservicesDatamodelPredictionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_predictions_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_predictions_dto.py new file mode 100644 index 0000000000..83be0fed4c --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_predictions_dto.py @@ -0,0 +1,79 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_predictions_dto import DataservicesDatamodelPredictionsDTO + +class TestDataservicesDatamodelPredictionsDTO(unittest.TestCase): + """DataservicesDatamodelPredictionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPredictionsDTO: + """Test DataservicesDatamodelPredictionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPredictionsDTO` + """ + model = DataservicesDatamodelPredictionsDTO() + if include_optional: + return DataservicesDatamodelPredictionsDTO( + predictions = [ + visier_platform_sdk.models.dataservices/datamodel/prediction_dto.dataservices.datamodel.PredictionDTO( + id = '', + display_name = '', + description = '', + subject = '', + subject_key = '', + subject_parent_key = '', + subject_filter = '', + event = '', + event_filter = '', + label_property = '', + factor_properties = [ + '' + ], + factor_dimensions = [ + '' + ], + factor_concepts = [ + '' + ], + data_start_date = '', + data_end_date = '', + score_name = '', + factors_name = '', + minimum_training_months = '', + is_multi_tenant = True, ) + ] + ) + else: + return DataservicesDatamodelPredictionsDTO( + ) + """ + + def testDataservicesDatamodelPredictionsDTO(self): + """Test DataservicesDatamodelPredictionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_properties_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_properties_dto.py new file mode 100644 index 0000000000..892ab650b8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_properties_dto.py @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_properties_dto import DataservicesDatamodelPropertiesDTO + +class TestDataservicesDatamodelPropertiesDTO(unittest.TestCase): + """DataservicesDatamodelPropertiesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPropertiesDTO: + """Test DataservicesDatamodelPropertiesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPropertiesDTO` + """ + model = DataservicesDatamodelPropertiesDTO() + if include_optional: + return DataservicesDatamodelPropertiesDTO( + properties = [ + visier_platform_sdk.models.dataservices/datamodel/property_dto.dataservices.datamodel.PropertyDTO( + id = '', + display_name = '', + description = '', + data_type = '', + primitive_data_type = '', + parameters = [ + visier_platform_sdk.models.dataservices/datamodel/parameter_definition_dto.dataservices.datamodel.ParameterDefinitionDTO( + member_parameter = None, + numeric_parameter = None, + plan_parameter = None, + aggregation_type_parameter = None, ) + ], + tags = [ + visier_platform_sdk.models.dataservices/datamodel/tag_map_element_dto.dataservices.datamodel.TagMapElementDTO( + id = '', + display_name = '', ) + ], + explanation = '', ) + ] + ) + else: + return DataservicesDatamodelPropertiesDTO( + ) + """ + + def testDataservicesDatamodelPropertiesDTO(self): + """Test DataservicesDatamodelPropertiesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_property_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_property_dto.py new file mode 100644 index 0000000000..86fff7211f --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_property_dto.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_property_dto import DataservicesDatamodelPropertyDTO + +class TestDataservicesDatamodelPropertyDTO(unittest.TestCase): + """DataservicesDatamodelPropertyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPropertyDTO: + """Test DataservicesDatamodelPropertyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPropertyDTO` + """ + model = DataservicesDatamodelPropertyDTO() + if include_optional: + return DataservicesDatamodelPropertyDTO( + id = '', + display_name = '', + description = '', + data_type = '', + primitive_data_type = '', + parameters = [ + visier_platform_sdk.models.dataservices/datamodel/parameter_definition_dto.dataservices.datamodel.ParameterDefinitionDTO( + member_parameter = None, + numeric_parameter = None, + plan_parameter = None, + aggregation_type_parameter = None, ) + ], + tags = [ + visier_platform_sdk.models.dataservices/datamodel/tag_map_element_dto.dataservices.datamodel.TagMapElementDTO( + id = '', + display_name = '', ) + ], + explanation = '' + ) + else: + return DataservicesDatamodelPropertyDTO( + ) + """ + + def testDataservicesDatamodelPropertyDTO(self): + """Test DataservicesDatamodelPropertyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_property_reference_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_property_reference_dto.py new file mode 100644 index 0000000000..8035e52b0e --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_property_reference_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_property_reference_dto import DataservicesDatamodelPropertyReferenceDTO + +class TestDataservicesDatamodelPropertyReferenceDTO(unittest.TestCase): + """DataservicesDatamodelPropertyReferenceDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelPropertyReferenceDTO: + """Test DataservicesDatamodelPropertyReferenceDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelPropertyReferenceDTO` + """ + model = DataservicesDatamodelPropertyReferenceDTO() + if include_optional: + return DataservicesDatamodelPropertyReferenceDTO( + name = '', + qualifying_path = '' + ) + else: + return DataservicesDatamodelPropertyReferenceDTO( + ) + """ + + def testDataservicesDatamodelPropertyReferenceDTO(self): + """Test DataservicesDatamodelPropertyReferenceDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_scenario_or_snapshot_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_scenario_or_snapshot_dto.py new file mode 100644 index 0000000000..e48aed7019 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_scenario_or_snapshot_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_scenario_or_snapshot_dto import DataservicesDatamodelScenarioOrSnapshotDTO + +class TestDataservicesDatamodelScenarioOrSnapshotDTO(unittest.TestCase): + """DataservicesDatamodelScenarioOrSnapshotDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelScenarioOrSnapshotDTO: + """Test DataservicesDatamodelScenarioOrSnapshotDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelScenarioOrSnapshotDTO` + """ + model = DataservicesDatamodelScenarioOrSnapshotDTO() + if include_optional: + return DataservicesDatamodelScenarioOrSnapshotDTO( + id = '', + display_name = '' + ) + else: + return DataservicesDatamodelScenarioOrSnapshotDTO( + ) + """ + + def testDataservicesDatamodelScenarioOrSnapshotDTO(self): + """Test DataservicesDatamodelScenarioOrSnapshotDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_selection_concept_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_selection_concept_dto.py new file mode 100644 index 0000000000..b2e33202c2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_selection_concept_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_dto import DataservicesDatamodelSelectionConceptDTO + +class TestDataservicesDatamodelSelectionConceptDTO(unittest.TestCase): + """DataservicesDatamodelSelectionConceptDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelSelectionConceptDTO: + """Test DataservicesDatamodelSelectionConceptDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelSelectionConceptDTO` + """ + model = DataservicesDatamodelSelectionConceptDTO() + if include_optional: + return DataservicesDatamodelSelectionConceptDTO( + id = '', + display_name = '', + description = '', + visible_in_app = True, + tags = [ + visier_platform_sdk.models.dataservices/datamodel/tag_map_element_dto.dataservices.datamodel.TagMapElementDTO( + id = '', + display_name = '', ) + ], + explanation = '' + ) + else: + return DataservicesDatamodelSelectionConceptDTO( + ) + """ + + def testDataservicesDatamodelSelectionConceptDTO(self): + """Test DataservicesDatamodelSelectionConceptDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_selection_concept_reference_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_selection_concept_reference_dto.py new file mode 100644 index 0000000000..5de343b177 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_selection_concept_reference_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_reference_dto import DataservicesDatamodelSelectionConceptReferenceDTO + +class TestDataservicesDatamodelSelectionConceptReferenceDTO(unittest.TestCase): + """DataservicesDatamodelSelectionConceptReferenceDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelSelectionConceptReferenceDTO: + """Test DataservicesDatamodelSelectionConceptReferenceDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelSelectionConceptReferenceDTO` + """ + model = DataservicesDatamodelSelectionConceptReferenceDTO() + if include_optional: + return DataservicesDatamodelSelectionConceptReferenceDTO( + name = '', + qualifying_path = '' + ) + else: + return DataservicesDatamodelSelectionConceptReferenceDTO( + ) + """ + + def testDataservicesDatamodelSelectionConceptReferenceDTO(self): + """Test DataservicesDatamodelSelectionConceptReferenceDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_selection_concepts_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_selection_concepts_dto.py new file mode 100644 index 0000000000..3bb564e2db --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_selection_concepts_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_selection_concepts_dto import DataservicesDatamodelSelectionConceptsDTO + +class TestDataservicesDatamodelSelectionConceptsDTO(unittest.TestCase): + """DataservicesDatamodelSelectionConceptsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelSelectionConceptsDTO: + """Test DataservicesDatamodelSelectionConceptsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelSelectionConceptsDTO` + """ + model = DataservicesDatamodelSelectionConceptsDTO() + if include_optional: + return DataservicesDatamodelSelectionConceptsDTO( + selection_concepts = [ + visier_platform_sdk.models.dataservices/datamodel/selection_concept_dto.dataservices.datamodel.SelectionConceptDTO( + id = '', + display_name = '', + description = '', + visible_in_app = True, + tags = [ + visier_platform_sdk.models.dataservices/datamodel/tag_map_element_dto.dataservices.datamodel.TagMapElementDTO( + id = '', + display_name = '', ) + ], + explanation = '', ) + ] + ) + else: + return DataservicesDatamodelSelectionConceptsDTO( + ) + """ + + def testDataservicesDatamodelSelectionConceptsDTO(self): + """Test DataservicesDatamodelSelectionConceptsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_tag_map_element_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_tag_map_element_dto.py new file mode 100644 index 0000000000..ce626fc15d --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_tag_map_element_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_tag_map_element_dto import DataservicesDatamodelTagMapElementDTO + +class TestDataservicesDatamodelTagMapElementDTO(unittest.TestCase): + """DataservicesDatamodelTagMapElementDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelTagMapElementDTO: + """Test DataservicesDatamodelTagMapElementDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelTagMapElementDTO` + """ + model = DataservicesDatamodelTagMapElementDTO() + if include_optional: + return DataservicesDatamodelTagMapElementDTO( + id = '', + display_name = '' + ) + else: + return DataservicesDatamodelTagMapElementDTO( + ) + """ + + def testDataservicesDatamodelTagMapElementDTO(self): + """Test DataservicesDatamodelTagMapElementDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_datamodel_validity_range_dto.py b/src/visier_platform_sdk/test/test_dataservices_datamodel_validity_range_dto.py new file mode 100644 index 0000000000..58f039f0ff --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_datamodel_validity_range_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_datamodel_validity_range_dto import DataservicesDatamodelValidityRangeDTO + +class TestDataservicesDatamodelValidityRangeDTO(unittest.TestCase): + """DataservicesDatamodelValidityRangeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesDatamodelValidityRangeDTO: + """Test DataservicesDatamodelValidityRangeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesDatamodelValidityRangeDTO` + """ + model = DataservicesDatamodelValidityRangeDTO() + if include_optional: + return DataservicesDatamodelValidityRangeDTO( + start = '', + end = '' + ) + else: + return DataservicesDatamodelValidityRangeDTO( + ) + """ + + def testDataservicesDatamodelValidityRangeDTO(self): + """Test DataservicesDatamodelValidityRangeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_dto.py new file mode 100644 index 0000000000..61c294160f --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_dto.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_aggregation_query_dto import DataservicesQueryAggregationQueryDTO + +class TestDataservicesQueryAggregationQueryDTO(unittest.TestCase): + """DataservicesQueryAggregationQueryDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryAggregationQueryDTO: + """Test DataservicesQueryAggregationQueryDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryAggregationQueryDTO` + """ + model = DataservicesQueryAggregationQueryDTO() + if include_optional: + return DataservicesQueryAggregationQueryDTO( + source = visier_platform_sdk.models.dataservices/query/aggregation_query_source_dto.dataservices.query.AggregationQuerySourceDTO( + formula = '', + metric = '', + metrics = None, ), + filters = [ + visier_platform_sdk.models.dataservices/query/query_filter_dto.dataservices.query.QueryFilterDTO( + formula = '', + selection_concept = None, + member_set = None, + cohort = None, ) + ], + axes = [ + visier_platform_sdk.models.dataservices/query/query_axis_dto.dataservices.query.QueryAxisDTO( + formula = '', + selection_concept = None, + dimension_member_selection = None, + member_map_selection = None, + numeric_ranges = None, + dimension_level_selection = None, + dimension_leaf_member_selection = None, + dimension_data_member_selection = None, + dimension_level_with_uncategorized_value_selection = None, + table_axis_options = None, ) + ], + time_intervals = visier_platform_sdk.models.dataservices/query/query_time_intervals_dto.dataservices.query.QueryTimeIntervalsDTO( + from_instant = '', + from_date_time = '', + dynamic_date_from = 'SOURCE', + interval_period_type = 'MONTH', + interval_period_count = 56, + interval_count = 56, + direction = 'BACKWARD', + shift = None, + trailing_period_type = 'MONTH', + trailing_period_count = 56, ), + parameter_values = [ + visier_platform_sdk.models.dataservices/query/query_parameter_value_dto.dataservices.query.QueryParameterValueDTO( + member_value = None, + numeric_value = None, + plan_value = None, + aggregation_type_value = None, ) + ] + ) + else: + return DataservicesQueryAggregationQueryDTO( + ) + """ + + def testDataservicesQueryAggregationQueryDTO(self): + """Test DataservicesQueryAggregationQueryDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_execution_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_execution_dto.py new file mode 100644 index 0000000000..421783a37e --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_execution_dto.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_aggregation_query_execution_dto import DataservicesQueryAggregationQueryExecutionDTO + +class TestDataservicesQueryAggregationQueryExecutionDTO(unittest.TestCase): + """DataservicesQueryAggregationQueryExecutionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryAggregationQueryExecutionDTO: + """Test DataservicesQueryAggregationQueryExecutionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryAggregationQueryExecutionDTO` + """ + model = DataservicesQueryAggregationQueryExecutionDTO() + if include_optional: + return DataservicesQueryAggregationQueryExecutionDTO( + query = visier_platform_sdk.models.dataservices/query/aggregation_query_dto.dataservices.query.AggregationQueryDTO( + source = None, + filters = [ + visier_platform_sdk.models.dataservices/query/query_filter_dto.dataservices.query.QueryFilterDTO( + formula = '', + selection_concept = None, + member_set = None, + cohort = None, ) + ], + axes = [ + visier_platform_sdk.models.dataservices/query/query_axis_dto.dataservices.query.QueryAxisDTO( + formula = '', + selection_concept = None, + dimension_member_selection = None, + member_map_selection = None, + numeric_ranges = None, + dimension_level_selection = None, + dimension_leaf_member_selection = None, + dimension_data_member_selection = None, + dimension_level_with_uncategorized_value_selection = None, + table_axis_options = None, ) + ], + time_intervals = None, + parameter_values = [ + visier_platform_sdk.models.dataservices/query/query_parameter_value_dto.dataservices.query.QueryParameterValueDTO( + member_value = None, + numeric_value = None, + plan_value = None, + aggregation_type_value = None, ) + ], ), + options = visier_platform_sdk.models.dataservices/query/query_execution_options_dto.dataservices.query.QueryExecutionOptionsDTO( + calendar_type = 'TENANT_CALENDAR', + currency_conversion_mode = 'TENANT_CURRENCY_CONVERSION', + currency_conversion_date = '', + lineage_depth = 56, + zero_visibility = 'SHOW', + null_visibility = 'SHOW', + cell_distribution_options = visier_platform_sdk.models.dataservices/query/cell_distribution_options_dto.dataservices.query.CellDistributionOptionsDTO( + bin_count = 56, ), + axis_visibility = 'SIMPLE', + enable_sparse_results = True, + internal = visier_platform_sdk.models.dataservices/query/internal_query_execution_options_dto.dataservices.query.InternalQueryExecutionOptionsDTO( + sparse_handling_mode = 'ALLOW', + align_time_axis_to_period_end = True, ), + enable_descending_space = True, + currency_conversion_code = '', + member_display_mode = 'DEFAULT', + axes_overall_value_mode = 'NONE', ) + ) + else: + return DataservicesQueryAggregationQueryExecutionDTO( + ) + """ + + def testDataservicesQueryAggregationQueryExecutionDTO(self): + """Test DataservicesQueryAggregationQueryExecutionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_source_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_source_dto.py new file mode 100644 index 0000000000..26651ec7f1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_source_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_dto import DataservicesQueryAggregationQuerySourceDTO + +class TestDataservicesQueryAggregationQuerySourceDTO(unittest.TestCase): + """DataservicesQueryAggregationQuerySourceDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryAggregationQuerySourceDTO: + """Test DataservicesQueryAggregationQuerySourceDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryAggregationQuerySourceDTO` + """ + model = DataservicesQueryAggregationQuerySourceDTO() + if include_optional: + return DataservicesQueryAggregationQuerySourceDTO( + formula = '', + metric = '', + metrics = visier_platform_sdk.models.dataservices/query/aggregation_query_source_metrics_dto.dataservices.query.AggregationQuerySourceMetricsDTO( + columns = [ + visier_platform_sdk.models.dataservices/query/aggregation_query_source_metric_dto.dataservices.query.AggregationQuerySourceMetricDTO( + column_name = '', + id = '', + formula = '', + qualifying_path = '', ) + ], ) + ) + else: + return DataservicesQueryAggregationQuerySourceDTO( + ) + """ + + def testDataservicesQueryAggregationQuerySourceDTO(self): + """Test DataservicesQueryAggregationQuerySourceDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_source_metric_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_source_metric_dto.py new file mode 100644 index 0000000000..e34d68daec --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_source_metric_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_metric_dto import DataservicesQueryAggregationQuerySourceMetricDTO + +class TestDataservicesQueryAggregationQuerySourceMetricDTO(unittest.TestCase): + """DataservicesQueryAggregationQuerySourceMetricDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryAggregationQuerySourceMetricDTO: + """Test DataservicesQueryAggregationQuerySourceMetricDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryAggregationQuerySourceMetricDTO` + """ + model = DataservicesQueryAggregationQuerySourceMetricDTO() + if include_optional: + return DataservicesQueryAggregationQuerySourceMetricDTO( + column_name = '', + id = '', + formula = '', + qualifying_path = '' + ) + else: + return DataservicesQueryAggregationQuerySourceMetricDTO( + ) + """ + + def testDataservicesQueryAggregationQuerySourceMetricDTO(self): + """Test DataservicesQueryAggregationQuerySourceMetricDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_source_metrics_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_source_metrics_dto.py new file mode 100644 index 0000000000..7add1c008e --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_query_source_metrics_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_metrics_dto import DataservicesQueryAggregationQuerySourceMetricsDTO + +class TestDataservicesQueryAggregationQuerySourceMetricsDTO(unittest.TestCase): + """DataservicesQueryAggregationQuerySourceMetricsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryAggregationQuerySourceMetricsDTO: + """Test DataservicesQueryAggregationQuerySourceMetricsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryAggregationQuerySourceMetricsDTO` + """ + model = DataservicesQueryAggregationQuerySourceMetricsDTO() + if include_optional: + return DataservicesQueryAggregationQuerySourceMetricsDTO( + columns = [ + visier_platform_sdk.models.dataservices/query/aggregation_query_source_metric_dto.dataservices.query.AggregationQuerySourceMetricDTO( + column_name = '', + id = '', + formula = '', + qualifying_path = '', ) + ] + ) + else: + return DataservicesQueryAggregationQuerySourceMetricsDTO( + ) + """ + + def testDataservicesQueryAggregationQuerySourceMetricsDTO(self): + """Test DataservicesQueryAggregationQuerySourceMetricsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_aggregation_type_parameter_value_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_type_parameter_value_dto.py new file mode 100644 index 0000000000..4e0843a362 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_aggregation_type_parameter_value_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_aggregation_type_parameter_value_dto import DataservicesQueryAggregationTypeParameterValueDTO + +class TestDataservicesQueryAggregationTypeParameterValueDTO(unittest.TestCase): + """DataservicesQueryAggregationTypeParameterValueDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryAggregationTypeParameterValueDTO: + """Test DataservicesQueryAggregationTypeParameterValueDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryAggregationTypeParameterValueDTO` + """ + model = DataservicesQueryAggregationTypeParameterValueDTO() + if include_optional: + return DataservicesQueryAggregationTypeParameterValueDTO( + parameter_id = '', + aggregation_option_id = '' + ) + else: + return DataservicesQueryAggregationTypeParameterValueDTO( + ) + """ + + def testDataservicesQueryAggregationTypeParameterValueDTO(self): + """Test DataservicesQueryAggregationTypeParameterValueDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_cell_distribution_bin_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_cell_distribution_bin_dto.py new file mode 100644 index 0000000000..12b8460d8b --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_cell_distribution_bin_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_cell_distribution_bin_dto import DataservicesQueryCellDistributionBinDTO + +class TestDataservicesQueryCellDistributionBinDTO(unittest.TestCase): + """DataservicesQueryCellDistributionBinDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryCellDistributionBinDTO: + """Test DataservicesQueryCellDistributionBinDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryCellDistributionBinDTO` + """ + model = DataservicesQueryCellDistributionBinDTO() + if include_optional: + return DataservicesQueryCellDistributionBinDTO( + value = '', + support = '' + ) + else: + return DataservicesQueryCellDistributionBinDTO( + ) + """ + + def testDataservicesQueryCellDistributionBinDTO(self): + """Test DataservicesQueryCellDistributionBinDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_cell_distribution_options_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_cell_distribution_options_dto.py new file mode 100644 index 0000000000..de595884c8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_cell_distribution_options_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_cell_distribution_options_dto import DataservicesQueryCellDistributionOptionsDTO + +class TestDataservicesQueryCellDistributionOptionsDTO(unittest.TestCase): + """DataservicesQueryCellDistributionOptionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryCellDistributionOptionsDTO: + """Test DataservicesQueryCellDistributionOptionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryCellDistributionOptionsDTO` + """ + model = DataservicesQueryCellDistributionOptionsDTO() + if include_optional: + return DataservicesQueryCellDistributionOptionsDTO( + bin_count = 56 + ) + else: + return DataservicesQueryCellDistributionOptionsDTO( + ) + """ + + def testDataservicesQueryCellDistributionOptionsDTO(self): + """Test DataservicesQueryCellDistributionOptionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_cell_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_cell_dto.py new file mode 100644 index 0000000000..57d98367b2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_cell_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_cell_dto import DataservicesQueryCellDTO + +class TestDataservicesQueryCellDTO(unittest.TestCase): + """DataservicesQueryCellDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryCellDTO: + """Test DataservicesQueryCellDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryCellDTO` + """ + model = DataservicesQueryCellDTO() + if include_optional: + return DataservicesQueryCellDTO( + value = '', + support = '', + coordinates = [ + 56 + ], + distribution = [ + visier_platform_sdk.models.dataservices/query/cell_distribution_bin_dto.dataservices.query.CellDistributionBinDTO( + value = '', + support = '', ) + ] + ) + else: + return DataservicesQueryCellDTO( + ) + """ + + def testDataservicesQueryCellDTO(self): + """Test DataservicesQueryCellDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_cell_set_axis_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_cell_set_axis_dto.py new file mode 100644 index 0000000000..083150b677 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_cell_set_axis_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_cell_set_axis_dto import DataservicesQueryCellSetAxisDTO + +class TestDataservicesQueryCellSetAxisDTO(unittest.TestCase): + """DataservicesQueryCellSetAxisDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryCellSetAxisDTO: + """Test DataservicesQueryCellSetAxisDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryCellSetAxisDTO` + """ + model = DataservicesQueryCellSetAxisDTO() + if include_optional: + return DataservicesQueryCellSetAxisDTO( + dimension = visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ), + positions = [ + visier_platform_sdk.models.dataservices/query/cell_set_axis_position_dto.dataservices.query.CellSetAxisPositionDTO( + path = [ + '' + ], + display_name = '', + display_name_path = [ + '' + ], ) + ] + ) + else: + return DataservicesQueryCellSetAxisDTO( + ) + """ + + def testDataservicesQueryCellSetAxisDTO(self): + """Test DataservicesQueryCellSetAxisDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_cell_set_axis_position_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_cell_set_axis_position_dto.py new file mode 100644 index 0000000000..2167704e0a --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_cell_set_axis_position_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_cell_set_axis_position_dto import DataservicesQueryCellSetAxisPositionDTO + +class TestDataservicesQueryCellSetAxisPositionDTO(unittest.TestCase): + """DataservicesQueryCellSetAxisPositionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryCellSetAxisPositionDTO: + """Test DataservicesQueryCellSetAxisPositionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryCellSetAxisPositionDTO` + """ + model = DataservicesQueryCellSetAxisPositionDTO() + if include_optional: + return DataservicesQueryCellSetAxisPositionDTO( + path = [ + '' + ], + display_name = '', + display_name_path = [ + '' + ] + ) + else: + return DataservicesQueryCellSetAxisPositionDTO( + ) + """ + + def testDataservicesQueryCellSetAxisPositionDTO(self): + """Test DataservicesQueryCellSetAxisPositionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_cell_set_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_cell_set_dto.py new file mode 100644 index 0000000000..201b0d51d1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_cell_set_dto.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_cell_set_dto import DataservicesQueryCellSetDTO + +class TestDataservicesQueryCellSetDTO(unittest.TestCase): + """DataservicesQueryCellSetDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryCellSetDTO: + """Test DataservicesQueryCellSetDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryCellSetDTO` + """ + model = DataservicesQueryCellSetDTO() + if include_optional: + return DataservicesQueryCellSetDTO( + cells = [ + visier_platform_sdk.models.dataservices/query/cell_dto.dataservices.query.CellDTO( + value = '', + support = '', + coordinates = [ + 56 + ], + distribution = [ + visier_platform_sdk.models.dataservices/query/cell_distribution_bin_dto.dataservices.query.CellDistributionBinDTO( + value = '', + support = '', ) + ], ) + ], + axes = [ + visier_platform_sdk.models.dataservices/query/cell_set_axis_dto.dataservices.query.CellSetAxisDTO( + dimension = None, + positions = [ + visier_platform_sdk.models.dataservices/query/cell_set_axis_position_dto.dataservices.query.CellSetAxisPositionDTO( + path = [ + '' + ], + display_name = '', + display_name_path = [ + '' + ], ) + ], ) + ], + lineage = visier_platform_sdk.models.dataservices/query/lineage_dto.dataservices.query.LineageDTO( + cell_sets = [ + visier_platform_sdk.models.dataservices/query/cell_set_dto.dataservices.query.CellSetDTO( + cells = [ + visier_platform_sdk.models.dataservices/query/cell_dto.dataservices.query.CellDTO( + value = '', + support = '', + coordinates = [ + 56 + ], + distribution = [ + visier_platform_sdk.models.dataservices/query/cell_distribution_bin_dto.dataservices.query.CellDistributionBinDTO( + value = '', + support = '', ) + ], ) + ], + axes = [ + visier_platform_sdk.models.dataservices/query/cell_set_axis_dto.dataservices.query.CellSetAxisDTO( + dimension = None, + positions = [ + visier_platform_sdk.models.dataservices/query/cell_set_axis_position_dto.dataservices.query.CellSetAxisPositionDTO( + path = [ + '' + ], + display_name = '', + display_name_path = [ + '' + ], ) + ], ) + ], + lineage = None, ) + ], + op = '', ) + ) + else: + return DataservicesQueryCellSetDTO( + ) + """ + + def testDataservicesQueryCellSetDTO(self): + """Test DataservicesQueryCellSetDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_cell_set_or_error_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_cell_set_or_error_dto.py new file mode 100644 index 0000000000..1c43ebc6ba --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_cell_set_or_error_dto.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_cell_set_or_error_dto import DataservicesQueryCellSetOrErrorDTO + +class TestDataservicesQueryCellSetOrErrorDTO(unittest.TestCase): + """DataservicesQueryCellSetOrErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryCellSetOrErrorDTO: + """Test DataservicesQueryCellSetOrErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryCellSetOrErrorDTO` + """ + model = DataservicesQueryCellSetOrErrorDTO() + if include_optional: + return DataservicesQueryCellSetOrErrorDTO( + cell_set = visier_platform_sdk.models.dataservices/query/cell_set_dto.dataservices.query.CellSetDTO( + cells = [ + visier_platform_sdk.models.dataservices/query/cell_dto.dataservices.query.CellDTO( + value = '', + support = '', + coordinates = [ + 56 + ], + distribution = [ + visier_platform_sdk.models.dataservices/query/cell_distribution_bin_dto.dataservices.query.CellDistributionBinDTO( + value = '', + support = '', ) + ], ) + ], + axes = [ + visier_platform_sdk.models.dataservices/query/cell_set_axis_dto.dataservices.query.CellSetAxisDTO( + dimension = None, + positions = [ + visier_platform_sdk.models.dataservices/query/cell_set_axis_position_dto.dataservices.query.CellSetAxisPositionDTO( + path = [ + '' + ], + display_name = '', + display_name_path = [ + '' + ], ) + ], ) + ], + lineage = None, ), + error = visier_platform_sdk.models.dataservices/query/query_execution_error_dto.dataservices.query.QueryExecutionErrorDTO( + error_code = '', + message = '', + all_errors = [ + visier_platform_sdk.models.dataservices/query/query_execution_errors_dto.dataservices.query.QueryExecutionErrorsDTO( + error_code = '', + message = '', + all_error_details = [ + visier_platform_sdk.models.dataservices/query/query_execution_error_details_dto.dataservices.query.QueryExecutionErrorDetailsDTO( + object_type = '', + query_index = 56, + column_index = 56, + error = '', ) + ], ) + ], ) + ) + else: + return DataservicesQueryCellSetOrErrorDTO( + ) + """ + + def testDataservicesQueryCellSetOrErrorDTO(self): + """Test DataservicesQueryCellSetOrErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_cohort_filter_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_cohort_filter_dto.py new file mode 100644 index 0000000000..0bc7b5895b --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_cohort_filter_dto.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_cohort_filter_dto import DataservicesQueryCohortFilterDTO + +class TestDataservicesQueryCohortFilterDTO(unittest.TestCase): + """DataservicesQueryCohortFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryCohortFilterDTO: + """Test DataservicesQueryCohortFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryCohortFilterDTO` + """ + model = DataservicesQueryCohortFilterDTO() + if include_optional: + return DataservicesQueryCohortFilterDTO( + key_group = visier_platform_sdk.models.dataservices/query/key_group_filter_dto.dataservices.query.KeyGroupFilterDTO( + filters = [ + visier_platform_sdk.models.dataservices/query/key_group_filter_item_dto.dataservices.query.KeyGroupFilterItemDTO( + formula = '', + selection_concept = None, + member_set = None, ) + ], ), + exclude = True, + time_interval = visier_platform_sdk.models.dataservices/query/query_time_interval_dto.dataservices.query.QueryTimeIntervalDTO( + from_instant = '', + from_date_time = '', + dynamic_date_from = 'SOURCE', + interval_period_type = 'MONTH', + interval_period_count = 56, + direction = 'BACKWARD', + shift = None, ) + ) + else: + return DataservicesQueryCohortFilterDTO( + ) + """ + + def testDataservicesQueryCohortFilterDTO(self): + """Test DataservicesQueryCohortFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_internal_query_execution_options_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_internal_query_execution_options_dto.py new file mode 100644 index 0000000000..66c53093fe --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_internal_query_execution_options_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_internal_query_execution_options_dto import DataservicesQueryInternalQueryExecutionOptionsDTO + +class TestDataservicesQueryInternalQueryExecutionOptionsDTO(unittest.TestCase): + """DataservicesQueryInternalQueryExecutionOptionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryInternalQueryExecutionOptionsDTO: + """Test DataservicesQueryInternalQueryExecutionOptionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryInternalQueryExecutionOptionsDTO` + """ + model = DataservicesQueryInternalQueryExecutionOptionsDTO() + if include_optional: + return DataservicesQueryInternalQueryExecutionOptionsDTO( + sparse_handling_mode = 'ALLOW', + align_time_axis_to_period_end = True + ) + else: + return DataservicesQueryInternalQueryExecutionOptionsDTO( + ) + """ + + def testDataservicesQueryInternalQueryExecutionOptionsDTO(self): + """Test DataservicesQueryInternalQueryExecutionOptionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_key_group_filter_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_key_group_filter_dto.py new file mode 100644 index 0000000000..dc79c2f513 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_key_group_filter_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_key_group_filter_dto import DataservicesQueryKeyGroupFilterDTO + +class TestDataservicesQueryKeyGroupFilterDTO(unittest.TestCase): + """DataservicesQueryKeyGroupFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryKeyGroupFilterDTO: + """Test DataservicesQueryKeyGroupFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryKeyGroupFilterDTO` + """ + model = DataservicesQueryKeyGroupFilterDTO() + if include_optional: + return DataservicesQueryKeyGroupFilterDTO( + filters = [ + visier_platform_sdk.models.dataservices/query/key_group_filter_item_dto.dataservices.query.KeyGroupFilterItemDTO( + formula = '', + selection_concept = None, + member_set = None, ) + ] + ) + else: + return DataservicesQueryKeyGroupFilterDTO( + ) + """ + + def testDataservicesQueryKeyGroupFilterDTO(self): + """Test DataservicesQueryKeyGroupFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_key_group_filter_item_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_key_group_filter_item_dto.py new file mode 100644 index 0000000000..66c7c54aa4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_key_group_filter_item_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_key_group_filter_item_dto import DataservicesQueryKeyGroupFilterItemDTO + +class TestDataservicesQueryKeyGroupFilterItemDTO(unittest.TestCase): + """DataservicesQueryKeyGroupFilterItemDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryKeyGroupFilterItemDTO: + """Test DataservicesQueryKeyGroupFilterItemDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryKeyGroupFilterItemDTO` + """ + model = DataservicesQueryKeyGroupFilterItemDTO() + if include_optional: + return DataservicesQueryKeyGroupFilterItemDTO( + formula = '', + selection_concept = visier_platform_sdk.models.dataservices/datamodel/selection_concept_reference_dto.dataservices.datamodel.SelectionConceptReferenceDTO( + name = '', + qualifying_path = '', ), + member_set = visier_platform_sdk.models.dataservices/query/member_filter_dto.dataservices.query.MemberFilterDTO( + dimension = None, + values = None, ) + ) + else: + return DataservicesQueryKeyGroupFilterItemDTO( + ) + """ + + def testDataservicesQueryKeyGroupFilterItemDTO(self): + """Test DataservicesQueryKeyGroupFilterItemDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_lineage_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_lineage_dto.py new file mode 100644 index 0000000000..68d4378aca --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_lineage_dto.py @@ -0,0 +1,83 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_lineage_dto import DataservicesQueryLineageDTO + +class TestDataservicesQueryLineageDTO(unittest.TestCase): + """DataservicesQueryLineageDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryLineageDTO: + """Test DataservicesQueryLineageDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryLineageDTO` + """ + model = DataservicesQueryLineageDTO() + if include_optional: + return DataservicesQueryLineageDTO( + cell_sets = [ + visier_platform_sdk.models.dataservices/query/cell_set_dto.dataservices.query.CellSetDTO( + cells = [ + visier_platform_sdk.models.dataservices/query/cell_dto.dataservices.query.CellDTO( + value = '', + support = '', + coordinates = [ + 56 + ], + distribution = [ + visier_platform_sdk.models.dataservices/query/cell_distribution_bin_dto.dataservices.query.CellDistributionBinDTO( + value = '', + support = '', ) + ], ) + ], + axes = [ + visier_platform_sdk.models.dataservices/query/cell_set_axis_dto.dataservices.query.CellSetAxisDTO( + dimension = None, + positions = [ + visier_platform_sdk.models.dataservices/query/cell_set_axis_position_dto.dataservices.query.CellSetAxisPositionDTO( + path = [ + '' + ], + display_name = '', + display_name_path = [ + '' + ], ) + ], ) + ], + lineage = None, ) + ], + op = '' + ) + else: + return DataservicesQueryLineageDTO( + ) + """ + + def testDataservicesQueryLineageDTO(self): + """Test DataservicesQueryLineageDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_list_query_execution_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_list_query_execution_dto.py new file mode 100644 index 0000000000..ec86b852dd --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_list_query_execution_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_list_query_execution_dto import DataservicesQueryListQueryExecutionDTO + +class TestDataservicesQueryListQueryExecutionDTO(unittest.TestCase): + """DataservicesQueryListQueryExecutionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryListQueryExecutionDTO: + """Test DataservicesQueryListQueryExecutionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryListQueryExecutionDTO` + """ + model = DataservicesQueryListQueryExecutionDTO() + if include_optional: + return DataservicesQueryListQueryExecutionDTO( + source = visier_platform_sdk.models.dataservices/query/list_query_source_dto.dataservices.query.ListQuerySourceDTO( + formula = '', + metric = '', + analytic_object = '', + text_concept = '', ), + columns = [ + visier_platform_sdk.models.dataservices/query/property_column_dto.dataservices.query.PropertyColumnDTO( + column_name = '', + column_definition = None, ) + ], + sort_options = [ + visier_platform_sdk.models.dataservices/query/sort_option_dto.dataservices.query.SortOptionDTO( + column_index = 56, + sort_direction = 'SORT_ASCENDING', ) + ], + filters = [ + visier_platform_sdk.models.dataservices/query/query_filter_dto.dataservices.query.QueryFilterDTO( + formula = '', + selection_concept = None, + member_set = None, + cohort = None, ) + ], + time_interval = visier_platform_sdk.models.dataservices/query/query_time_interval_dto.dataservices.query.QueryTimeIntervalDTO( + from_instant = '', + from_date_time = '', + dynamic_date_from = 'SOURCE', + interval_period_type = 'MONTH', + interval_period_count = 56, + direction = 'BACKWARD', + shift = None, ), + parameter_values = [ + visier_platform_sdk.models.dataservices/query/query_parameter_value_dto.dataservices.query.QueryParameterValueDTO( + member_value = None, + numeric_value = None, + plan_value = None, + aggregation_type_value = None, ) + ], + options = visier_platform_sdk.models.dataservices/query/list_query_execution_options_dto.dataservices.query.ListQueryExecutionOptionsDTO( + limit = 56, + query_mode = 'DEFAULT', + omit_header = True, + calendar_type = 'TENANT_CALENDAR', + currency_conversion_mode = 'TENANT_CURRENCY_CONVERSION', + currency_conversion_date = '', + page = 56, + multiple_tables = True, + currency_conversion_code = '', + record_mode = 'NORMAL', + date_time_display_mode = 'EPOCH', ) + ) + else: + return DataservicesQueryListQueryExecutionDTO( + ) + """ + + def testDataservicesQueryListQueryExecutionDTO(self): + """Test DataservicesQueryListQueryExecutionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_list_query_execution_options_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_list_query_execution_options_dto.py new file mode 100644 index 0000000000..72333d8640 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_list_query_execution_options_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_list_query_execution_options_dto import DataservicesQueryListQueryExecutionOptionsDTO + +class TestDataservicesQueryListQueryExecutionOptionsDTO(unittest.TestCase): + """DataservicesQueryListQueryExecutionOptionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryListQueryExecutionOptionsDTO: + """Test DataservicesQueryListQueryExecutionOptionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryListQueryExecutionOptionsDTO` + """ + model = DataservicesQueryListQueryExecutionOptionsDTO() + if include_optional: + return DataservicesQueryListQueryExecutionOptionsDTO( + limit = 56, + query_mode = 'DEFAULT', + omit_header = True, + calendar_type = 'TENANT_CALENDAR', + currency_conversion_mode = 'TENANT_CURRENCY_CONVERSION', + currency_conversion_date = '', + page = 56, + multiple_tables = True, + currency_conversion_code = '', + record_mode = 'NORMAL', + date_time_display_mode = 'EPOCH' + ) + else: + return DataservicesQueryListQueryExecutionOptionsDTO( + ) + """ + + def testDataservicesQueryListQueryExecutionOptionsDTO(self): + """Test DataservicesQueryListQueryExecutionOptionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_list_query_source_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_list_query_source_dto.py new file mode 100644 index 0000000000..af45807b6e --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_list_query_source_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_list_query_source_dto import DataservicesQueryListQuerySourceDTO + +class TestDataservicesQueryListQuerySourceDTO(unittest.TestCase): + """DataservicesQueryListQuerySourceDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryListQuerySourceDTO: + """Test DataservicesQueryListQuerySourceDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryListQuerySourceDTO` + """ + model = DataservicesQueryListQuerySourceDTO() + if include_optional: + return DataservicesQueryListQuerySourceDTO( + formula = '', + metric = '', + analytic_object = '', + text_concept = '' + ) + else: + return DataservicesQueryListQuerySourceDTO( + ) + """ + + def testDataservicesQueryListQuerySourceDTO(self): + """Test DataservicesQueryListQuerySourceDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_member_filter_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_member_filter_dto.py new file mode 100644 index 0000000000..8eaa28b6aa --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_member_filter_dto.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_member_filter_dto import DataservicesQueryMemberFilterDTO + +class TestDataservicesQueryMemberFilterDTO(unittest.TestCase): + """DataservicesQueryMemberFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryMemberFilterDTO: + """Test DataservicesQueryMemberFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryMemberFilterDTO` + """ + model = DataservicesQueryMemberFilterDTO() + if include_optional: + return DataservicesQueryMemberFilterDTO( + dimension = visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ), + values = visier_platform_sdk.models.dataservices/common/member_values_dto.dataservices.common.MemberValuesDTO( + included = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '', ) + ], + excluded = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + member_id = '', ) + ], ) + ) + else: + return DataservicesQueryMemberFilterDTO( + ) + """ + + def testDataservicesQueryMemberFilterDTO(self): + """Test DataservicesQueryMemberFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_member_parameter_value_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_member_parameter_value_dto.py new file mode 100644 index 0000000000..837025ba8e --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_member_parameter_value_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_member_parameter_value_dto import DataservicesQueryMemberParameterValueDTO + +class TestDataservicesQueryMemberParameterValueDTO(unittest.TestCase): + """DataservicesQueryMemberParameterValueDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryMemberParameterValueDTO: + """Test DataservicesQueryMemberParameterValueDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryMemberParameterValueDTO` + """ + model = DataservicesQueryMemberParameterValueDTO() + if include_optional: + return DataservicesQueryMemberParameterValueDTO( + parameter_id = '', + dimension_id = '', + reference_path = [ + '' + ], + values = visier_platform_sdk.models.dataservices/common/member_values_dto.dataservices.common.MemberValuesDTO( + included = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '', ) + ], + excluded = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + member_id = '', ) + ], ) + ) + else: + return DataservicesQueryMemberParameterValueDTO( + ) + """ + + def testDataservicesQueryMemberParameterValueDTO(self): + """Test DataservicesQueryMemberParameterValueDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_numeric_parameter_value_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_numeric_parameter_value_dto.py new file mode 100644 index 0000000000..75dcae814b --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_numeric_parameter_value_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_numeric_parameter_value_dto import DataservicesQueryNumericParameterValueDTO + +class TestDataservicesQueryNumericParameterValueDTO(unittest.TestCase): + """DataservicesQueryNumericParameterValueDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryNumericParameterValueDTO: + """Test DataservicesQueryNumericParameterValueDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryNumericParameterValueDTO` + """ + model = DataservicesQueryNumericParameterValueDTO() + if include_optional: + return DataservicesQueryNumericParameterValueDTO( + parameter_id = '', + value = 1.337 + ) + else: + return DataservicesQueryNumericParameterValueDTO( + ) + """ + + def testDataservicesQueryNumericParameterValueDTO(self): + """Test DataservicesQueryNumericParameterValueDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_plan_parameter_value_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_plan_parameter_value_dto.py new file mode 100644 index 0000000000..6e8cf09d4d --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_plan_parameter_value_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_plan_parameter_value_dto import DataservicesQueryPlanParameterValueDTO + +class TestDataservicesQueryPlanParameterValueDTO(unittest.TestCase): + """DataservicesQueryPlanParameterValueDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryPlanParameterValueDTO: + """Test DataservicesQueryPlanParameterValueDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryPlanParameterValueDTO` + """ + model = DataservicesQueryPlanParameterValueDTO() + if include_optional: + return DataservicesQueryPlanParameterValueDTO( + parameter_id = '', + plan_id = '', + scenario_id = '', + snapshot_id = '' + ) + else: + return DataservicesQueryPlanParameterValueDTO( + ) + """ + + def testDataservicesQueryPlanParameterValueDTO(self): + """Test DataservicesQueryPlanParameterValueDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_property_column_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_property_column_dto.py new file mode 100644 index 0000000000..1322fd121c --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_property_column_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_property_column_dto import DataservicesQueryPropertyColumnDTO + +class TestDataservicesQueryPropertyColumnDTO(unittest.TestCase): + """DataservicesQueryPropertyColumnDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryPropertyColumnDTO: + """Test DataservicesQueryPropertyColumnDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryPropertyColumnDTO` + """ + model = DataservicesQueryPropertyColumnDTO() + if include_optional: + return DataservicesQueryPropertyColumnDTO( + column_name = '', + column_definition = visier_platform_sdk.models.dataservices/query/query_property_dto.dataservices.query.QueryPropertyDTO( + formula = '', + property = None, + selection_concept = None, + dimension = None, + member_map_property = None, + effective_date_property = None, + dimension_level_selection = None, ) + ) + else: + return DataservicesQueryPropertyColumnDTO( + ) + """ + + def testDataservicesQueryPropertyColumnDTO(self): + """Test DataservicesQueryPropertyColumnDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_axis_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_axis_dto.py new file mode 100644 index 0000000000..d7ea968812 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_axis_dto.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_axis_dto import DataservicesQueryQueryAxisDTO + +class TestDataservicesQueryQueryAxisDTO(unittest.TestCase): + """DataservicesQueryQueryAxisDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryAxisDTO: + """Test DataservicesQueryQueryAxisDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryAxisDTO` + """ + model = DataservicesQueryQueryAxisDTO() + if include_optional: + return DataservicesQueryQueryAxisDTO( + formula = '', + selection_concept = visier_platform_sdk.models.dataservices/datamodel/selection_concept_reference_dto.dataservices.datamodel.SelectionConceptReferenceDTO( + name = '', + qualifying_path = '', ), + dimension_member_selection = visier_platform_sdk.models.dataservices/query/query_dimension_member_selection_dto.dataservices.query.QueryDimensionMemberSelectionDTO( + dimension = None, + members = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '', ) + ], ), + member_map_selection = visier_platform_sdk.models.dataservices/query/query_member_map_selection_dto.dataservices.query.QueryMemberMapSelectionDTO( + member_map = None, + target_dimension_name = '', + members = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '', ) + ], ), + numeric_ranges = visier_platform_sdk.models.dataservices/query/query_numeric_ranges_dto.dataservices.query.QueryNumericRangesDTO( + property = None, + ranges = '', + include_negative = True, + include_independent_zero_range = True, + include_all_member = True, ), + dimension_level_selection = visier_platform_sdk.models.dataservices/query/query_dimension_level_selection_dto.dataservices.query.QueryDimensionLevelSelectionDTO( + dimension = None, + level_ids = [ + '' + ], + level_depths = [ + 56 + ], ), + dimension_leaf_member_selection = visier_platform_sdk.models.dataservices/query/query_dimension_leaf_selection_dto.dataservices.query.QueryDimensionLeafSelectionDTO( + dimension = None, ), + dimension_data_member_selection = visier_platform_sdk.models.dataservices/query/query_dimension_data_member_selection_dto.dataservices.query.QueryDimensionDataMemberSelectionDTO( + dimension = None, ), + dimension_level_with_uncategorized_value_selection = visier_platform_sdk.models.dataservices/query/query_dimension_level_selection_dto.dataservices.query.QueryDimensionLevelSelectionDTO( + dimension = None, + level_ids = [ + '' + ], + level_depths = [ + 56 + ], ), + table_axis_options = visier_platform_sdk.models.dataservices/query/query_axis_options_dto.dataservices.query.QueryAxisOptionsDTO( + member_display_mode = 'UNCHANGED', + column_name = '', ) + ) + else: + return DataservicesQueryQueryAxisDTO( + ) + """ + + def testDataservicesQueryQueryAxisDTO(self): + """Test DataservicesQueryQueryAxisDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_axis_options_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_axis_options_dto.py new file mode 100644 index 0000000000..aafbc03474 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_axis_options_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_axis_options_dto import DataservicesQueryQueryAxisOptionsDTO + +class TestDataservicesQueryQueryAxisOptionsDTO(unittest.TestCase): + """DataservicesQueryQueryAxisOptionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryAxisOptionsDTO: + """Test DataservicesQueryQueryAxisOptionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryAxisOptionsDTO` + """ + model = DataservicesQueryQueryAxisOptionsDTO() + if include_optional: + return DataservicesQueryQueryAxisOptionsDTO( + member_display_mode = 'UNCHANGED', + column_name = '' + ) + else: + return DataservicesQueryQueryAxisOptionsDTO( + ) + """ + + def testDataservicesQueryQueryAxisOptionsDTO(self): + """Test DataservicesQueryQueryAxisOptionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_data_member_selection_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_data_member_selection_dto.py new file mode 100644 index 0000000000..f080513b36 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_data_member_selection_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_dimension_data_member_selection_dto import DataservicesQueryQueryDimensionDataMemberSelectionDTO + +class TestDataservicesQueryQueryDimensionDataMemberSelectionDTO(unittest.TestCase): + """DataservicesQueryQueryDimensionDataMemberSelectionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryDimensionDataMemberSelectionDTO: + """Test DataservicesQueryQueryDimensionDataMemberSelectionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryDimensionDataMemberSelectionDTO` + """ + model = DataservicesQueryQueryDimensionDataMemberSelectionDTO() + if include_optional: + return DataservicesQueryQueryDimensionDataMemberSelectionDTO( + dimension = visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ) + ) + else: + return DataservicesQueryQueryDimensionDataMemberSelectionDTO( + ) + """ + + def testDataservicesQueryQueryDimensionDataMemberSelectionDTO(self): + """Test DataservicesQueryQueryDimensionDataMemberSelectionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_leaf_selection_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_leaf_selection_dto.py new file mode 100644 index 0000000000..d7ef251056 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_leaf_selection_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_dimension_leaf_selection_dto import DataservicesQueryQueryDimensionLeafSelectionDTO + +class TestDataservicesQueryQueryDimensionLeafSelectionDTO(unittest.TestCase): + """DataservicesQueryQueryDimensionLeafSelectionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryDimensionLeafSelectionDTO: + """Test DataservicesQueryQueryDimensionLeafSelectionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryDimensionLeafSelectionDTO` + """ + model = DataservicesQueryQueryDimensionLeafSelectionDTO() + if include_optional: + return DataservicesQueryQueryDimensionLeafSelectionDTO( + dimension = visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ) + ) + else: + return DataservicesQueryQueryDimensionLeafSelectionDTO( + ) + """ + + def testDataservicesQueryQueryDimensionLeafSelectionDTO(self): + """Test DataservicesQueryQueryDimensionLeafSelectionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_level_property_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_level_property_dto.py new file mode 100644 index 0000000000..34355647bc --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_level_property_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_dimension_level_property_dto import DataservicesQueryQueryDimensionLevelPropertyDTO + +class TestDataservicesQueryQueryDimensionLevelPropertyDTO(unittest.TestCase): + """DataservicesQueryQueryDimensionLevelPropertyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryDimensionLevelPropertyDTO: + """Test DataservicesQueryQueryDimensionLevelPropertyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryDimensionLevelPropertyDTO` + """ + model = DataservicesQueryQueryDimensionLevelPropertyDTO() + if include_optional: + return DataservicesQueryQueryDimensionLevelPropertyDTO( + dimension = visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ), + member_value_mode = 'NAME', + level_id = '', + level_depth = 56 + ) + else: + return DataservicesQueryQueryDimensionLevelPropertyDTO( + ) + """ + + def testDataservicesQueryQueryDimensionLevelPropertyDTO(self): + """Test DataservicesQueryQueryDimensionLevelPropertyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_level_selection_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_level_selection_dto.py new file mode 100644 index 0000000000..67db80e093 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_level_selection_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_dimension_level_selection_dto import DataservicesQueryQueryDimensionLevelSelectionDTO + +class TestDataservicesQueryQueryDimensionLevelSelectionDTO(unittest.TestCase): + """DataservicesQueryQueryDimensionLevelSelectionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryDimensionLevelSelectionDTO: + """Test DataservicesQueryQueryDimensionLevelSelectionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryDimensionLevelSelectionDTO` + """ + model = DataservicesQueryQueryDimensionLevelSelectionDTO() + if include_optional: + return DataservicesQueryQueryDimensionLevelSelectionDTO( + dimension = visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ), + level_ids = [ + '' + ], + level_depths = [ + 56 + ] + ) + else: + return DataservicesQueryQueryDimensionLevelSelectionDTO( + ) + """ + + def testDataservicesQueryQueryDimensionLevelSelectionDTO(self): + """Test DataservicesQueryQueryDimensionLevelSelectionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_member_selection_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_member_selection_dto.py new file mode 100644 index 0000000000..9529963fd4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_dimension_member_selection_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_dimension_member_selection_dto import DataservicesQueryQueryDimensionMemberSelectionDTO + +class TestDataservicesQueryQueryDimensionMemberSelectionDTO(unittest.TestCase): + """DataservicesQueryQueryDimensionMemberSelectionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryDimensionMemberSelectionDTO: + """Test DataservicesQueryQueryDimensionMemberSelectionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryDimensionMemberSelectionDTO` + """ + model = DataservicesQueryQueryDimensionMemberSelectionDTO() + if include_optional: + return DataservicesQueryQueryDimensionMemberSelectionDTO( + dimension = visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ), + members = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '', ) + ] + ) + else: + return DataservicesQueryQueryDimensionMemberSelectionDTO( + ) + """ + + def testDataservicesQueryQueryDimensionMemberSelectionDTO(self): + """Test DataservicesQueryQueryDimensionMemberSelectionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_execution_error_details_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_execution_error_details_dto.py new file mode 100644 index 0000000000..8e843f6f9b --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_execution_error_details_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_execution_error_details_dto import DataservicesQueryQueryExecutionErrorDetailsDTO + +class TestDataservicesQueryQueryExecutionErrorDetailsDTO(unittest.TestCase): + """DataservicesQueryQueryExecutionErrorDetailsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryExecutionErrorDetailsDTO: + """Test DataservicesQueryQueryExecutionErrorDetailsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryExecutionErrorDetailsDTO` + """ + model = DataservicesQueryQueryExecutionErrorDetailsDTO() + if include_optional: + return DataservicesQueryQueryExecutionErrorDetailsDTO( + object_type = '', + query_index = 56, + column_index = 56, + error = '' + ) + else: + return DataservicesQueryQueryExecutionErrorDetailsDTO( + ) + """ + + def testDataservicesQueryQueryExecutionErrorDetailsDTO(self): + """Test DataservicesQueryQueryExecutionErrorDetailsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_execution_error_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_execution_error_dto.py new file mode 100644 index 0000000000..e137270e8a --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_execution_error_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_execution_error_dto import DataservicesQueryQueryExecutionErrorDTO + +class TestDataservicesQueryQueryExecutionErrorDTO(unittest.TestCase): + """DataservicesQueryQueryExecutionErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryExecutionErrorDTO: + """Test DataservicesQueryQueryExecutionErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryExecutionErrorDTO` + """ + model = DataservicesQueryQueryExecutionErrorDTO() + if include_optional: + return DataservicesQueryQueryExecutionErrorDTO( + error_code = '', + message = '', + all_errors = [ + visier_platform_sdk.models.dataservices/query/query_execution_errors_dto.dataservices.query.QueryExecutionErrorsDTO( + error_code = '', + message = '', + all_error_details = [ + visier_platform_sdk.models.dataservices/query/query_execution_error_details_dto.dataservices.query.QueryExecutionErrorDetailsDTO( + object_type = '', + query_index = 56, + column_index = 56, + error = '', ) + ], ) + ] + ) + else: + return DataservicesQueryQueryExecutionErrorDTO( + ) + """ + + def testDataservicesQueryQueryExecutionErrorDTO(self): + """Test DataservicesQueryQueryExecutionErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_execution_errors_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_execution_errors_dto.py new file mode 100644 index 0000000000..66d98dfd14 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_execution_errors_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_execution_errors_dto import DataservicesQueryQueryExecutionErrorsDTO + +class TestDataservicesQueryQueryExecutionErrorsDTO(unittest.TestCase): + """DataservicesQueryQueryExecutionErrorsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryExecutionErrorsDTO: + """Test DataservicesQueryQueryExecutionErrorsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryExecutionErrorsDTO` + """ + model = DataservicesQueryQueryExecutionErrorsDTO() + if include_optional: + return DataservicesQueryQueryExecutionErrorsDTO( + error_code = '', + message = '', + all_error_details = [ + visier_platform_sdk.models.dataservices/query/query_execution_error_details_dto.dataservices.query.QueryExecutionErrorDetailsDTO( + object_type = '', + query_index = 56, + column_index = 56, + error = '', ) + ] + ) + else: + return DataservicesQueryQueryExecutionErrorsDTO( + ) + """ + + def testDataservicesQueryQueryExecutionErrorsDTO(self): + """Test DataservicesQueryQueryExecutionErrorsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_execution_options_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_execution_options_dto.py new file mode 100644 index 0000000000..707bb65f75 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_execution_options_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_execution_options_dto import DataservicesQueryQueryExecutionOptionsDTO + +class TestDataservicesQueryQueryExecutionOptionsDTO(unittest.TestCase): + """DataservicesQueryQueryExecutionOptionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryExecutionOptionsDTO: + """Test DataservicesQueryQueryExecutionOptionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryExecutionOptionsDTO` + """ + model = DataservicesQueryQueryExecutionOptionsDTO() + if include_optional: + return DataservicesQueryQueryExecutionOptionsDTO( + calendar_type = 'TENANT_CALENDAR', + currency_conversion_mode = 'TENANT_CURRENCY_CONVERSION', + currency_conversion_date = '', + lineage_depth = 56, + zero_visibility = 'SHOW', + null_visibility = 'SHOW', + cell_distribution_options = visier_platform_sdk.models.dataservices/query/cell_distribution_options_dto.dataservices.query.CellDistributionOptionsDTO( + bin_count = 56, ), + axis_visibility = 'SIMPLE', + enable_sparse_results = True, + internal = visier_platform_sdk.models.dataservices/query/internal_query_execution_options_dto.dataservices.query.InternalQueryExecutionOptionsDTO( + sparse_handling_mode = 'ALLOW', + align_time_axis_to_period_end = True, ), + enable_descending_space = True, + currency_conversion_code = '', + member_display_mode = 'DEFAULT', + axes_overall_value_mode = 'NONE' + ) + else: + return DataservicesQueryQueryExecutionOptionsDTO( + ) + """ + + def testDataservicesQueryQueryExecutionOptionsDTO(self): + """Test DataservicesQueryQueryExecutionOptionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_filter_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_filter_dto.py new file mode 100644 index 0000000000..7614beb2f6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_filter_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_filter_dto import DataservicesQueryQueryFilterDTO + +class TestDataservicesQueryQueryFilterDTO(unittest.TestCase): + """DataservicesQueryQueryFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryFilterDTO: + """Test DataservicesQueryQueryFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryFilterDTO` + """ + model = DataservicesQueryQueryFilterDTO() + if include_optional: + return DataservicesQueryQueryFilterDTO( + formula = '', + selection_concept = visier_platform_sdk.models.dataservices/datamodel/selection_concept_reference_dto.dataservices.datamodel.SelectionConceptReferenceDTO( + name = '', + qualifying_path = '', ), + member_set = visier_platform_sdk.models.dataservices/query/member_filter_dto.dataservices.query.MemberFilterDTO( + dimension = None, + values = None, ), + cohort = visier_platform_sdk.models.dataservices/query/cohort_filter_dto.dataservices.query.CohortFilterDTO( + key_group = None, + exclude = True, + time_interval = None, ) + ) + else: + return DataservicesQueryQueryFilterDTO( + ) + """ + + def testDataservicesQueryQueryFilterDTO(self): + """Test DataservicesQueryQueryFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_member_map_property_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_member_map_property_dto.py new file mode 100644 index 0000000000..b751ae3297 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_member_map_property_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_member_map_property_dto import DataservicesQueryQueryMemberMapPropertyDTO + +class TestDataservicesQueryQueryMemberMapPropertyDTO(unittest.TestCase): + """DataservicesQueryQueryMemberMapPropertyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryMemberMapPropertyDTO: + """Test DataservicesQueryQueryMemberMapPropertyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryMemberMapPropertyDTO` + """ + model = DataservicesQueryQueryMemberMapPropertyDTO() + if include_optional: + return DataservicesQueryQueryMemberMapPropertyDTO( + member_map = visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ), + target_dimension_name = '' + ) + else: + return DataservicesQueryQueryMemberMapPropertyDTO( + ) + """ + + def testDataservicesQueryQueryMemberMapPropertyDTO(self): + """Test DataservicesQueryQueryMemberMapPropertyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_member_map_selection_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_member_map_selection_dto.py new file mode 100644 index 0000000000..2f86454341 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_member_map_selection_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_member_map_selection_dto import DataservicesQueryQueryMemberMapSelectionDTO + +class TestDataservicesQueryQueryMemberMapSelectionDTO(unittest.TestCase): + """DataservicesQueryQueryMemberMapSelectionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryMemberMapSelectionDTO: + """Test DataservicesQueryQueryMemberMapSelectionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryMemberMapSelectionDTO` + """ + model = DataservicesQueryQueryMemberMapSelectionDTO() + if include_optional: + return DataservicesQueryQueryMemberMapSelectionDTO( + member_map = visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ), + target_dimension_name = '', + members = [ + visier_platform_sdk.models.dataservices/common/dimension_member_reference_dto.dataservices.common.DimensionMemberReferenceDTO( + path = [ + '' + ], + member_id = '', ) + ] + ) + else: + return DataservicesQueryQueryMemberMapSelectionDTO( + ) + """ + + def testDataservicesQueryQueryMemberMapSelectionDTO(self): + """Test DataservicesQueryQueryMemberMapSelectionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_numeric_ranges_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_numeric_ranges_dto.py new file mode 100644 index 0000000000..e9d8578758 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_numeric_ranges_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_numeric_ranges_dto import DataservicesQueryQueryNumericRangesDTO + +class TestDataservicesQueryQueryNumericRangesDTO(unittest.TestCase): + """DataservicesQueryQueryNumericRangesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryNumericRangesDTO: + """Test DataservicesQueryQueryNumericRangesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryNumericRangesDTO` + """ + model = DataservicesQueryQueryNumericRangesDTO() + if include_optional: + return DataservicesQueryQueryNumericRangesDTO( + var_property = visier_platform_sdk.models.dataservices/query/query_property_dto.dataservices.query.QueryPropertyDTO( + formula = '', + property = None, + selection_concept = None, + dimension = None, + member_map_property = None, + effective_date_property = None, + dimension_level_selection = None, ), + ranges = '', + include_negative = True, + include_independent_zero_range = True, + include_all_member = True + ) + else: + return DataservicesQueryQueryNumericRangesDTO( + ) + """ + + def testDataservicesQueryQueryNumericRangesDTO(self): + """Test DataservicesQueryQueryNumericRangesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_parameter_value_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_parameter_value_dto.py new file mode 100644 index 0000000000..e26641ffef --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_parameter_value_dto.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_parameter_value_dto import DataservicesQueryQueryParameterValueDTO + +class TestDataservicesQueryQueryParameterValueDTO(unittest.TestCase): + """DataservicesQueryQueryParameterValueDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryParameterValueDTO: + """Test DataservicesQueryQueryParameterValueDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryParameterValueDTO` + """ + model = DataservicesQueryQueryParameterValueDTO() + if include_optional: + return DataservicesQueryQueryParameterValueDTO( + member_value = visier_platform_sdk.models.dataservices/query/member_parameter_value_dto.dataservices.query.MemberParameterValueDTO( + parameter_id = '', + dimension_id = '', + reference_path = [ + '' + ], + values = None, ), + numeric_value = visier_platform_sdk.models.dataservices/query/numeric_parameter_value_dto.dataservices.query.NumericParameterValueDTO( + parameter_id = '', + value = 1.337, ), + plan_value = visier_platform_sdk.models.dataservices/query/plan_parameter_value_dto.dataservices.query.PlanParameterValueDTO( + parameter_id = '', + plan_id = '', + scenario_id = '', + snapshot_id = '', ), + aggregation_type_value = visier_platform_sdk.models.dataservices/query/aggregation_type_parameter_value_dto.dataservices.query.AggregationTypeParameterValueDTO( + parameter_id = '', + aggregation_option_id = '', ) + ) + else: + return DataservicesQueryQueryParameterValueDTO( + ) + """ + + def testDataservicesQueryQueryParameterValueDTO(self): + """Test DataservicesQueryQueryParameterValueDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_property_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_property_dto.py new file mode 100644 index 0000000000..0156dc9e70 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_property_dto.py @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_property_dto import DataservicesQueryQueryPropertyDTO + +class TestDataservicesQueryQueryPropertyDTO(unittest.TestCase): + """DataservicesQueryQueryPropertyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryPropertyDTO: + """Test DataservicesQueryQueryPropertyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryPropertyDTO` + """ + model = DataservicesQueryQueryPropertyDTO() + if include_optional: + return DataservicesQueryQueryPropertyDTO( + formula = '', + var_property = visier_platform_sdk.models.dataservices/datamodel/property_reference_dto.dataservices.datamodel.PropertyReferenceDTO( + name = '', + qualifying_path = '', ), + selection_concept = visier_platform_sdk.models.dataservices/datamodel/selection_concept_reference_dto.dataservices.datamodel.SelectionConceptReferenceDTO( + name = '', + qualifying_path = '', ), + dimension = visier_platform_sdk.models.dataservices/datamodel/dimension_reference_dto.dataservices.datamodel.DimensionReferenceDTO( + name = '', + qualifying_path = '', ), + member_map_property = visier_platform_sdk.models.dataservices/query/query_member_map_property_dto.dataservices.query.QueryMemberMapPropertyDTO( + member_map = None, + target_dimension_name = '', ), + effective_date_property = None, + dimension_level_selection = visier_platform_sdk.models.dataservices/query/query_dimension_level_property_dto.dataservices.query.QueryDimensionLevelPropertyDTO( + dimension = None, + member_value_mode = 'NAME', + level_id = '', + level_depth = 56, ) + ) + else: + return DataservicesQueryQueryPropertyDTO( + ) + """ + + def testDataservicesQueryQueryPropertyDTO(self): + """Test DataservicesQueryQueryPropertyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_time_interval_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_time_interval_dto.py new file mode 100644 index 0000000000..fda2c7d5db --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_time_interval_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_time_interval_dto import DataservicesQueryQueryTimeIntervalDTO + +class TestDataservicesQueryQueryTimeIntervalDTO(unittest.TestCase): + """DataservicesQueryQueryTimeIntervalDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryTimeIntervalDTO: + """Test DataservicesQueryQueryTimeIntervalDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryTimeIntervalDTO` + """ + model = DataservicesQueryQueryTimeIntervalDTO() + if include_optional: + return DataservicesQueryQueryTimeIntervalDTO( + from_instant = '', + from_date_time = '', + dynamic_date_from = 'SOURCE', + interval_period_type = 'MONTH', + interval_period_count = 56, + direction = 'BACKWARD', + shift = visier_platform_sdk.models.dataservices/query/time_shift_dto.dataservices.query.TimeShiftDTO( + period_type = 'MONTH', + period_count = 56, + direction = 'BACKWARD', ) + ) + else: + return DataservicesQueryQueryTimeIntervalDTO( + ) + """ + + def testDataservicesQueryQueryTimeIntervalDTO(self): + """Test DataservicesQueryQueryTimeIntervalDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_query_time_intervals_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_query_time_intervals_dto.py new file mode 100644 index 0000000000..28ec8cc948 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_query_time_intervals_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_query_time_intervals_dto import DataservicesQueryQueryTimeIntervalsDTO + +class TestDataservicesQueryQueryTimeIntervalsDTO(unittest.TestCase): + """DataservicesQueryQueryTimeIntervalsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryQueryTimeIntervalsDTO: + """Test DataservicesQueryQueryTimeIntervalsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryQueryTimeIntervalsDTO` + """ + model = DataservicesQueryQueryTimeIntervalsDTO() + if include_optional: + return DataservicesQueryQueryTimeIntervalsDTO( + from_instant = '', + from_date_time = '', + dynamic_date_from = 'SOURCE', + interval_period_type = 'MONTH', + interval_period_count = 56, + interval_count = 56, + direction = 'BACKWARD', + shift = visier_platform_sdk.models.dataservices/query/time_shift_dto.dataservices.query.TimeShiftDTO( + period_type = 'MONTH', + period_count = 56, + direction = 'BACKWARD', ), + trailing_period_type = 'MONTH', + trailing_period_count = 56 + ) + else: + return DataservicesQueryQueryTimeIntervalsDTO( + ) + """ + + def testDataservicesQueryQueryTimeIntervalsDTO(self): + """Test DataservicesQueryQueryTimeIntervalsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_snapshot_query_execution_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_snapshot_query_execution_dto.py new file mode 100644 index 0000000000..b002b0bd08 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_snapshot_query_execution_dto.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_snapshot_query_execution_dto import DataservicesQuerySnapshotQueryExecutionDTO + +class TestDataservicesQuerySnapshotQueryExecutionDTO(unittest.TestCase): + """DataservicesQuerySnapshotQueryExecutionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQuerySnapshotQueryExecutionDTO: + """Test DataservicesQuerySnapshotQueryExecutionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQuerySnapshotQueryExecutionDTO` + """ + model = DataservicesQuerySnapshotQueryExecutionDTO() + if include_optional: + return DataservicesQuerySnapshotQueryExecutionDTO( + source = visier_platform_sdk.models.dataservices/query/list_query_source_dto.dataservices.query.ListQuerySourceDTO( + formula = '', + metric = '', + analytic_object = '', + text_concept = '', ), + columns = [ + visier_platform_sdk.models.dataservices/query/property_column_dto.dataservices.query.PropertyColumnDTO( + column_name = '', + column_definition = None, ) + ], + sort_options = [ + visier_platform_sdk.models.dataservices/query/sort_option_dto.dataservices.query.SortOptionDTO( + column_index = 56, + sort_direction = 'SORT_ASCENDING', ) + ], + filters = [ + visier_platform_sdk.models.dataservices/query/query_filter_dto.dataservices.query.QueryFilterDTO( + formula = '', + selection_concept = None, + member_set = None, + cohort = None, ) + ], + time_intervals = visier_platform_sdk.models.dataservices/query/query_time_intervals_dto.dataservices.query.QueryTimeIntervalsDTO( + from_instant = '', + from_date_time = '', + dynamic_date_from = 'SOURCE', + interval_period_type = 'MONTH', + interval_period_count = 56, + interval_count = 56, + direction = 'BACKWARD', + shift = None, + trailing_period_type = 'MONTH', + trailing_period_count = 56, ), + parameter_values = [ + visier_platform_sdk.models.dataservices/query/query_parameter_value_dto.dataservices.query.QueryParameterValueDTO( + member_value = None, + numeric_value = None, + plan_value = None, + aggregation_type_value = None, ) + ], + options = visier_platform_sdk.models.dataservices/query/snapshot_query_execution_options_dto.dataservices.query.SnapshotQueryExecutionOptionsDTO( + limit = 56, + query_mode = 'DEFAULT', + omit_header = True, + calendar_type = 'TENANT_CALENDAR', + currency_conversion_date = '', + page = 56, + multiple_tables = True, + currency_conversion_code = '', + date_time_display_mode = 'EPOCH', ) + ) + else: + return DataservicesQuerySnapshotQueryExecutionDTO( + ) + """ + + def testDataservicesQuerySnapshotQueryExecutionDTO(self): + """Test DataservicesQuerySnapshotQueryExecutionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_snapshot_query_execution_options_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_snapshot_query_execution_options_dto.py new file mode 100644 index 0000000000..eb74c4b7e7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_snapshot_query_execution_options_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_snapshot_query_execution_options_dto import DataservicesQuerySnapshotQueryExecutionOptionsDTO + +class TestDataservicesQuerySnapshotQueryExecutionOptionsDTO(unittest.TestCase): + """DataservicesQuerySnapshotQueryExecutionOptionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQuerySnapshotQueryExecutionOptionsDTO: + """Test DataservicesQuerySnapshotQueryExecutionOptionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQuerySnapshotQueryExecutionOptionsDTO` + """ + model = DataservicesQuerySnapshotQueryExecutionOptionsDTO() + if include_optional: + return DataservicesQuerySnapshotQueryExecutionOptionsDTO( + limit = 56, + query_mode = 'DEFAULT', + omit_header = True, + calendar_type = 'TENANT_CALENDAR', + currency_conversion_date = '', + page = 56, + multiple_tables = True, + currency_conversion_code = '', + date_time_display_mode = 'EPOCH' + ) + else: + return DataservicesQuerySnapshotQueryExecutionOptionsDTO( + ) + """ + + def testDataservicesQuerySnapshotQueryExecutionOptionsDTO(self): + """Test DataservicesQuerySnapshotQueryExecutionOptionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_sort_option_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_sort_option_dto.py new file mode 100644 index 0000000000..df6d12f597 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_sort_option_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_sort_option_dto import DataservicesQuerySortOptionDTO + +class TestDataservicesQuerySortOptionDTO(unittest.TestCase): + """DataservicesQuerySortOptionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQuerySortOptionDTO: + """Test DataservicesQuerySortOptionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQuerySortOptionDTO` + """ + model = DataservicesQuerySortOptionDTO() + if include_optional: + return DataservicesQuerySortOptionDTO( + column_index = 56, + sort_direction = 'SORT_ASCENDING' + ) + else: + return DataservicesQuerySortOptionDTO( + ) + """ + + def testDataservicesQuerySortOptionDTO(self): + """Test DataservicesQuerySortOptionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_sql_like_query_execution_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_sql_like_query_execution_dto.py new file mode 100644 index 0000000000..8a2cdb78e8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_sql_like_query_execution_dto.py @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_sql_like_query_execution_dto import DataservicesQuerySqlLikeQueryExecutionDTO + +class TestDataservicesQuerySqlLikeQueryExecutionDTO(unittest.TestCase): + """DataservicesQuerySqlLikeQueryExecutionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQuerySqlLikeQueryExecutionDTO: + """Test DataservicesQuerySqlLikeQueryExecutionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQuerySqlLikeQueryExecutionDTO` + """ + model = DataservicesQuerySqlLikeQueryExecutionDTO() + if include_optional: + return DataservicesQuerySqlLikeQueryExecutionDTO( + query = '', + options = visier_platform_sdk.models.dataservices/query/query_execution_options_dto.dataservices.query.QueryExecutionOptionsDTO( + calendar_type = 'TENANT_CALENDAR', + currency_conversion_mode = 'TENANT_CURRENCY_CONVERSION', + currency_conversion_date = '', + lineage_depth = 56, + zero_visibility = 'SHOW', + null_visibility = 'SHOW', + cell_distribution_options = visier_platform_sdk.models.dataservices/query/cell_distribution_options_dto.dataservices.query.CellDistributionOptionsDTO( + bin_count = 56, ), + axis_visibility = 'SIMPLE', + enable_sparse_results = True, + internal = visier_platform_sdk.models.dataservices/query/internal_query_execution_options_dto.dataservices.query.InternalQueryExecutionOptionsDTO( + sparse_handling_mode = 'ALLOW', + align_time_axis_to_period_end = True, ), + enable_descending_space = True, + currency_conversion_code = '', + member_display_mode = 'DEFAULT', + axes_overall_value_mode = 'NONE', ) + ) + else: + return DataservicesQuerySqlLikeQueryExecutionDTO( + ) + """ + + def testDataservicesQuerySqlLikeQueryExecutionDTO(self): + """Test DataservicesQuerySqlLikeQueryExecutionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dataservices_query_time_shift_dto.py b/src/visier_platform_sdk/test/test_dataservices_query_time_shift_dto.py new file mode 100644 index 0000000000..909d611232 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dataservices_query_time_shift_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dataservices_query_time_shift_dto import DataservicesQueryTimeShiftDTO + +class TestDataservicesQueryTimeShiftDTO(unittest.TestCase): + """DataservicesQueryTimeShiftDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DataservicesQueryTimeShiftDTO: + """Test DataservicesQueryTimeShiftDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DataservicesQueryTimeShiftDTO` + """ + model = DataservicesQueryTimeShiftDTO() + if include_optional: + return DataservicesQueryTimeShiftDTO( + period_type = 'MONTH', + period_count = 56, + direction = 'BACKWARD' + ) + else: + return DataservicesQueryTimeShiftDTO( + ) + """ + + def testDataservicesQueryTimeShiftDTO(self): + """Test DataservicesQueryTimeShiftDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_description_entry.py b/src/visier_platform_sdk/test/test_description_entry.py new file mode 100644 index 0000000000..2e61f17a5a --- /dev/null +++ b/src/visier_platform_sdk/test/test_description_entry.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.description_entry import DescriptionEntry + +class TestDescriptionEntry(unittest.TestCase): + """DescriptionEntry unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DescriptionEntry: + """Test DescriptionEntry + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DescriptionEntry` + """ + model = DescriptionEntry() + if include_optional: + return DescriptionEntry( + label = '', + text = '' + ) + else: + return DescriptionEntry( + ) + """ + + def testDescriptionEntry(self): + """Test DescriptionEntry""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_adp_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_adp_auth_params_dto.py new file mode 100644 index 0000000000..55e97c260c --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_adp_auth_params_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_adp_auth_params_dto import DesignerAdpAuthParamsDTO + +class TestDesignerAdpAuthParamsDTO(unittest.TestCase): + """DesignerAdpAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerAdpAuthParamsDTO: + """Test DesignerAdpAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerAdpAuthParamsDTO` + """ + model = DesignerAdpAuthParamsDTO() + if include_optional: + return DesignerAdpAuthParamsDTO( + auth_code = '' + ) + else: + return DesignerAdpAuthParamsDTO( + ) + """ + + def testDesignerAdpAuthParamsDTO(self): + """Test DesignerAdpAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_analytic_object_filter_dto.py b/src/visier_platform_sdk/test/test_designer_api_analytic_object_filter_dto.py new file mode 100644 index 0000000000..6ed617c3d0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_analytic_object_filter_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_analytic_object_filter_dto import DesignerApiAnalyticObjectFilterDTO + +class TestDesignerApiAnalyticObjectFilterDTO(unittest.TestCase): + """DesignerApiAnalyticObjectFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiAnalyticObjectFilterDTO: + """Test DesignerApiAnalyticObjectFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiAnalyticObjectFilterDTO` + """ + model = DesignerApiAnalyticObjectFilterDTO() + if include_optional: + return DesignerApiAnalyticObjectFilterDTO( + analytic_object_uuid = '', + symbol_name = '', + dimensions = [ + visier_platform_sdk.models.designer/api/dimension_filter_dto.designer.api.DimensionFilterDTO( + dimension_id = '', + symbol_name = '', + dimension_members = [ + visier_platform_sdk.models.designer/api/dimension_member_dto.designer.api.DimensionMemberDTO( + dimension_member = [ + '' + ], ) + ], ) + ] + ) + else: + return DesignerApiAnalyticObjectFilterDTO( + ) + """ + + def testDesignerApiAnalyticObjectFilterDTO(self): + """Test DesignerApiAnalyticObjectFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_calculation_concept_configuration_dto.py b/src/visier_platform_sdk/test/test_designer_api_calculation_concept_configuration_dto.py new file mode 100644 index 0000000000..52532a6616 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_calculation_concept_configuration_dto.py @@ -0,0 +1,77 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_calculation_concept_configuration_dto import DesignerApiCalculationConceptConfigurationDTO + +class TestDesignerApiCalculationConceptConfigurationDTO(unittest.TestCase): + """DesignerApiCalculationConceptConfigurationDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiCalculationConceptConfigurationDTO: + """Test DesignerApiCalculationConceptConfigurationDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiCalculationConceptConfigurationDTO` + """ + model = DesignerApiCalculationConceptConfigurationDTO() + if include_optional: + return DesignerApiCalculationConceptConfigurationDTO( + perspectives = [ + visier_platform_sdk.models.designer/api/perspective_configuration_dto.designer.api.PerspectiveConfigurationDTO( + perspective_id = '', + perspective_name = '', + perspective_nodes = [ + visier_platform_sdk.models.designer/api/perspective_node_dto.designer.api.PerspectiveNodeDTO( + selection_concept_uuid = '', + symbol_name = '', + analytic_object_filters = [ + visier_platform_sdk.models.designer/api/analytic_object_filter_dto.designer.api.AnalyticObjectFilterDTO( + analytic_object_uuid = '', + symbol_name = '', + dimensions = [ + visier_platform_sdk.models.designer/api/dimension_filter_dto.designer.api.DimensionFilterDTO( + dimension_id = '', + symbol_name = '', + dimension_members = [ + visier_platform_sdk.models.designer/api/dimension_member_dto.designer.api.DimensionMemberDTO( + dimension_member = [ + '' + ], ) + ], ) + ], ) + ], ) + ], ) + ] + ) + else: + return DesignerApiCalculationConceptConfigurationDTO( + ) + """ + + def testDesignerApiCalculationConceptConfigurationDTO(self): + """Test DesignerApiCalculationConceptConfigurationDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_calculation_concept_configuration_map_dto.py b/src/visier_platform_sdk/test/test_designer_api_calculation_concept_configuration_map_dto.py new file mode 100644 index 0000000000..166dceb83f --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_calculation_concept_configuration_map_dto.py @@ -0,0 +1,77 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_calculation_concept_configuration_map_dto import DesignerApiCalculationConceptConfigurationMapDTO + +class TestDesignerApiCalculationConceptConfigurationMapDTO(unittest.TestCase): + """DesignerApiCalculationConceptConfigurationMapDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiCalculationConceptConfigurationMapDTO: + """Test DesignerApiCalculationConceptConfigurationMapDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiCalculationConceptConfigurationMapDTO` + """ + model = DesignerApiCalculationConceptConfigurationMapDTO() + if include_optional: + return DesignerApiCalculationConceptConfigurationMapDTO( + perspectives_to_map = [ + visier_platform_sdk.models.designer/api/perspective_configuration_dto.designer.api.PerspectiveConfigurationDTO( + perspective_id = '', + perspective_name = '', + perspective_nodes = [ + visier_platform_sdk.models.designer/api/perspective_node_dto.designer.api.PerspectiveNodeDTO( + selection_concept_uuid = '', + symbol_name = '', + analytic_object_filters = [ + visier_platform_sdk.models.designer/api/analytic_object_filter_dto.designer.api.AnalyticObjectFilterDTO( + analytic_object_uuid = '', + symbol_name = '', + dimensions = [ + visier_platform_sdk.models.designer/api/dimension_filter_dto.designer.api.DimensionFilterDTO( + dimension_id = '', + symbol_name = '', + dimension_members = [ + visier_platform_sdk.models.designer/api/dimension_member_dto.designer.api.DimensionMemberDTO( + dimension_member = [ + '' + ], ) + ], ) + ], ) + ], ) + ], ) + ] + ) + else: + return DesignerApiCalculationConceptConfigurationMapDTO( + ) + """ + + def testDesignerApiCalculationConceptConfigurationMapDTO(self): + """Test DesignerApiCalculationConceptConfigurationMapDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_calculation_concept_dto.py b/src/visier_platform_sdk/test/test_designer_api_calculation_concept_dto.py new file mode 100644 index 0000000000..c2db40668c --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_calculation_concept_dto.py @@ -0,0 +1,80 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_calculation_concept_dto import DesignerApiCalculationConceptDTO + +class TestDesignerApiCalculationConceptDTO(unittest.TestCase): + """DesignerApiCalculationConceptDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiCalculationConceptDTO: + """Test DesignerApiCalculationConceptDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiCalculationConceptDTO` + """ + model = DesignerApiCalculationConceptDTO() + if include_optional: + return DesignerApiCalculationConceptDTO( + uuid = '', + name = '', + configuration = visier_platform_sdk.models.designer/api/calculation_concept_configuration_dto.designer.api.CalculationConceptConfigurationDTO( + perspectives = [ + visier_platform_sdk.models.designer/api/perspective_configuration_dto.designer.api.PerspectiveConfigurationDTO( + perspective_id = '', + perspective_name = '', + perspective_nodes = [ + visier_platform_sdk.models.designer/api/perspective_node_dto.designer.api.PerspectiveNodeDTO( + selection_concept_uuid = '', + symbol_name = '', + analytic_object_filters = [ + visier_platform_sdk.models.designer/api/analytic_object_filter_dto.designer.api.AnalyticObjectFilterDTO( + analytic_object_uuid = '', + symbol_name = '', + dimensions = [ + visier_platform_sdk.models.designer/api/dimension_filter_dto.designer.api.DimensionFilterDTO( + dimension_id = '', + symbol_name = '', + dimension_members = [ + visier_platform_sdk.models.designer/api/dimension_member_dto.designer.api.DimensionMemberDTO( + dimension_member = [ + '' + ], ) + ], ) + ], ) + ], ) + ], ) + ], ) + ) + else: + return DesignerApiCalculationConceptDTO( + ) + """ + + def testDesignerApiCalculationConceptDTO(self): + """Test DesignerApiCalculationConceptDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_calculation_concept_list_dto.py b/src/visier_platform_sdk/test/test_designer_api_calculation_concept_list_dto.py new file mode 100644 index 0000000000..c84e4637d6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_calculation_concept_list_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_calculation_concept_list_dto import DesignerApiCalculationConceptListDTO + +class TestDesignerApiCalculationConceptListDTO(unittest.TestCase): + """DesignerApiCalculationConceptListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiCalculationConceptListDTO: + """Test DesignerApiCalculationConceptListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiCalculationConceptListDTO` + """ + model = DesignerApiCalculationConceptListDTO() + if include_optional: + return DesignerApiCalculationConceptListDTO( + concepts = [ + visier_platform_sdk.models.designer/api/calculation_concept_dto.designer.api.CalculationConceptDTO( + uuid = '', + name = '', + configuration = None, ) + ] + ) + else: + return DesignerApiCalculationConceptListDTO( + ) + """ + + def testDesignerApiCalculationConceptListDTO(self): + """Test DesignerApiCalculationConceptListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_concept_configuration_result_dto.py b/src/visier_platform_sdk/test/test_designer_api_concept_configuration_result_dto.py new file mode 100644 index 0000000000..a8dcd6cbd3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_concept_configuration_result_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_concept_configuration_result_dto import DesignerApiConceptConfigurationResultDTO + +class TestDesignerApiConceptConfigurationResultDTO(unittest.TestCase): + """DesignerApiConceptConfigurationResultDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiConceptConfigurationResultDTO: + """Test DesignerApiConceptConfigurationResultDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiConceptConfigurationResultDTO` + """ + model = DesignerApiConceptConfigurationResultDTO() + if include_optional: + return DesignerApiConceptConfigurationResultDTO( + concept_id = '', + project_id = '', + message = '' + ) + else: + return DesignerApiConceptConfigurationResultDTO( + ) + """ + + def testDesignerApiConceptConfigurationResultDTO(self): + """Test DesignerApiConceptConfigurationResultDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_dimension_filter_dto.py b/src/visier_platform_sdk/test/test_designer_api_dimension_filter_dto.py new file mode 100644 index 0000000000..33ac15234b --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_dimension_filter_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_dimension_filter_dto import DesignerApiDimensionFilterDTO + +class TestDesignerApiDimensionFilterDTO(unittest.TestCase): + """DesignerApiDimensionFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiDimensionFilterDTO: + """Test DesignerApiDimensionFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiDimensionFilterDTO` + """ + model = DesignerApiDimensionFilterDTO() + if include_optional: + return DesignerApiDimensionFilterDTO( + dimension_id = '', + symbol_name = '', + dimension_members = [ + visier_platform_sdk.models.designer/api/dimension_member_dto.designer.api.DimensionMemberDTO( + dimension_member = [ + '' + ], ) + ] + ) + else: + return DesignerApiDimensionFilterDTO( + ) + """ + + def testDesignerApiDimensionFilterDTO(self): + """Test DesignerApiDimensionFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_dimension_member_dto.py b/src/visier_platform_sdk/test/test_designer_api_dimension_member_dto.py new file mode 100644 index 0000000000..dc2e116c89 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_dimension_member_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_dimension_member_dto import DesignerApiDimensionMemberDTO + +class TestDesignerApiDimensionMemberDTO(unittest.TestCase): + """DesignerApiDimensionMemberDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiDimensionMemberDTO: + """Test DesignerApiDimensionMemberDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiDimensionMemberDTO` + """ + model = DesignerApiDimensionMemberDTO() + if include_optional: + return DesignerApiDimensionMemberDTO( + dimension_member = [ + '' + ] + ) + else: + return DesignerApiDimensionMemberDTO( + ) + """ + + def testDesignerApiDimensionMemberDTO(self): + """Test DesignerApiDimensionMemberDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_perspective_configuration_dto.py b/src/visier_platform_sdk/test/test_designer_api_perspective_configuration_dto.py new file mode 100644 index 0000000000..9ddb05d141 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_perspective_configuration_dto.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_perspective_configuration_dto import DesignerApiPerspectiveConfigurationDTO + +class TestDesignerApiPerspectiveConfigurationDTO(unittest.TestCase): + """DesignerApiPerspectiveConfigurationDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiPerspectiveConfigurationDTO: + """Test DesignerApiPerspectiveConfigurationDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiPerspectiveConfigurationDTO` + """ + model = DesignerApiPerspectiveConfigurationDTO() + if include_optional: + return DesignerApiPerspectiveConfigurationDTO( + perspective_id = '', + perspective_name = '', + perspective_nodes = [ + visier_platform_sdk.models.designer/api/perspective_node_dto.designer.api.PerspectiveNodeDTO( + selection_concept_uuid = '', + symbol_name = '', + analytic_object_filters = [ + visier_platform_sdk.models.designer/api/analytic_object_filter_dto.designer.api.AnalyticObjectFilterDTO( + analytic_object_uuid = '', + symbol_name = '', + dimensions = [ + visier_platform_sdk.models.designer/api/dimension_filter_dto.designer.api.DimensionFilterDTO( + dimension_id = '', + symbol_name = '', + dimension_members = [ + visier_platform_sdk.models.designer/api/dimension_member_dto.designer.api.DimensionMemberDTO( + dimension_member = [ + '' + ], ) + ], ) + ], ) + ], ) + ] + ) + else: + return DesignerApiPerspectiveConfigurationDTO( + ) + """ + + def testDesignerApiPerspectiveConfigurationDTO(self): + """Test DesignerApiPerspectiveConfigurationDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_perspective_node_dto.py b/src/visier_platform_sdk/test/test_designer_api_perspective_node_dto.py new file mode 100644 index 0000000000..40d3cbd6f2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_perspective_node_dto.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_perspective_node_dto import DesignerApiPerspectiveNodeDTO + +class TestDesignerApiPerspectiveNodeDTO(unittest.TestCase): + """DesignerApiPerspectiveNodeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiPerspectiveNodeDTO: + """Test DesignerApiPerspectiveNodeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiPerspectiveNodeDTO` + """ + model = DesignerApiPerspectiveNodeDTO() + if include_optional: + return DesignerApiPerspectiveNodeDTO( + selection_concept_uuid = '', + symbol_name = '', + analytic_object_filters = [ + visier_platform_sdk.models.designer/api/analytic_object_filter_dto.designer.api.AnalyticObjectFilterDTO( + analytic_object_uuid = '', + symbol_name = '', + dimensions = [ + visier_platform_sdk.models.designer/api/dimension_filter_dto.designer.api.DimensionFilterDTO( + dimension_id = '', + symbol_name = '', + dimension_members = [ + visier_platform_sdk.models.designer/api/dimension_member_dto.designer.api.DimensionMemberDTO( + dimension_member = [ + '' + ], ) + ], ) + ], ) + ] + ) + else: + return DesignerApiPerspectiveNodeDTO( + ) + """ + + def testDesignerApiPerspectiveNodeDTO(self): + """Test DesignerApiPerspectiveNodeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_selection_concept_configuration_dto.py b/src/visier_platform_sdk/test/test_designer_api_selection_concept_configuration_dto.py new file mode 100644 index 0000000000..909f68c716 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_selection_concept_configuration_dto.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_selection_concept_configuration_dto import DesignerApiSelectionConceptConfigurationDTO + +class TestDesignerApiSelectionConceptConfigurationDTO(unittest.TestCase): + """DesignerApiSelectionConceptConfigurationDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiSelectionConceptConfigurationDTO: + """Test DesignerApiSelectionConceptConfigurationDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiSelectionConceptConfigurationDTO` + """ + model = DesignerApiSelectionConceptConfigurationDTO() + if include_optional: + return DesignerApiSelectionConceptConfigurationDTO( + analytic_object_filters = [ + visier_platform_sdk.models.designer/api/analytic_object_filter_dto.designer.api.AnalyticObjectFilterDTO( + analytic_object_uuid = '', + symbol_name = '', + dimensions = [ + visier_platform_sdk.models.designer/api/dimension_filter_dto.designer.api.DimensionFilterDTO( + dimension_id = '', + symbol_name = '', + dimension_members = [ + visier_platform_sdk.models.designer/api/dimension_member_dto.designer.api.DimensionMemberDTO( + dimension_member = [ + '' + ], ) + ], ) + ], ) + ] + ) + else: + return DesignerApiSelectionConceptConfigurationDTO( + ) + """ + + def testDesignerApiSelectionConceptConfigurationDTO(self): + """Test DesignerApiSelectionConceptConfigurationDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_selection_concept_configuration_map_dto.py b/src/visier_platform_sdk/test/test_designer_api_selection_concept_configuration_map_dto.py new file mode 100644 index 0000000000..424ac2eead --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_selection_concept_configuration_map_dto.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_selection_concept_configuration_map_dto import DesignerApiSelectionConceptConfigurationMapDTO + +class TestDesignerApiSelectionConceptConfigurationMapDTO(unittest.TestCase): + """DesignerApiSelectionConceptConfigurationMapDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiSelectionConceptConfigurationMapDTO: + """Test DesignerApiSelectionConceptConfigurationMapDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiSelectionConceptConfigurationMapDTO` + """ + model = DesignerApiSelectionConceptConfigurationMapDTO() + if include_optional: + return DesignerApiSelectionConceptConfigurationMapDTO( + analytic_object_filters_to_map = [ + visier_platform_sdk.models.designer/api/analytic_object_filter_dto.designer.api.AnalyticObjectFilterDTO( + analytic_object_uuid = '', + symbol_name = '', + dimensions = [ + visier_platform_sdk.models.designer/api/dimension_filter_dto.designer.api.DimensionFilterDTO( + dimension_id = '', + symbol_name = '', + dimension_members = [ + visier_platform_sdk.models.designer/api/dimension_member_dto.designer.api.DimensionMemberDTO( + dimension_member = [ + '' + ], ) + ], ) + ], ) + ] + ) + else: + return DesignerApiSelectionConceptConfigurationMapDTO( + ) + """ + + def testDesignerApiSelectionConceptConfigurationMapDTO(self): + """Test DesignerApiSelectionConceptConfigurationMapDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_selection_concept_dto.py b/src/visier_platform_sdk/test/test_designer_api_selection_concept_dto.py new file mode 100644 index 0000000000..a789281ce4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_selection_concept_dto.py @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_selection_concept_dto import DesignerApiSelectionConceptDTO + +class TestDesignerApiSelectionConceptDTO(unittest.TestCase): + """DesignerApiSelectionConceptDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiSelectionConceptDTO: + """Test DesignerApiSelectionConceptDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiSelectionConceptDTO` + """ + model = DesignerApiSelectionConceptDTO() + if include_optional: + return DesignerApiSelectionConceptDTO( + uuid = '', + name = '', + configuration = visier_platform_sdk.models.designer/api/selection_concept_configuration_dto.designer.api.SelectionConceptConfigurationDTO( + analytic_object_filters = [ + visier_platform_sdk.models.designer/api/analytic_object_filter_dto.designer.api.AnalyticObjectFilterDTO( + analytic_object_uuid = '', + symbol_name = '', + dimensions = [ + visier_platform_sdk.models.designer/api/dimension_filter_dto.designer.api.DimensionFilterDTO( + dimension_id = '', + symbol_name = '', + dimension_members = [ + visier_platform_sdk.models.designer/api/dimension_member_dto.designer.api.DimensionMemberDTO( + dimension_member = [ + '' + ], ) + ], ) + ], ) + ], ) + ) + else: + return DesignerApiSelectionConceptDTO( + ) + """ + + def testDesignerApiSelectionConceptDTO(self): + """Test DesignerApiSelectionConceptDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_api_selection_concept_list_dto.py b/src/visier_platform_sdk/test/test_designer_api_selection_concept_list_dto.py new file mode 100644 index 0000000000..8f27226880 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_api_selection_concept_list_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_api_selection_concept_list_dto import DesignerApiSelectionConceptListDTO + +class TestDesignerApiSelectionConceptListDTO(unittest.TestCase): + """DesignerApiSelectionConceptListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerApiSelectionConceptListDTO: + """Test DesignerApiSelectionConceptListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerApiSelectionConceptListDTO` + """ + model = DesignerApiSelectionConceptListDTO() + if include_optional: + return DesignerApiSelectionConceptListDTO( + concepts = [ + visier_platform_sdk.models.designer/api/selection_concept_dto.designer.api.SelectionConceptDTO( + uuid = '', + name = '', + configuration = None, ) + ] + ) + else: + return DesignerApiSelectionConceptListDTO( + ) + """ + + def testDesignerApiSelectionConceptListDTO(self): + """Test DesignerApiSelectionConceptListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_bamboo_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_bamboo_auth_params_dto.py new file mode 100644 index 0000000000..c69dab2ab7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_bamboo_auth_params_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_bamboo_auth_params_dto import DesignerBambooAuthParamsDTO + +class TestDesignerBambooAuthParamsDTO(unittest.TestCase): + """DesignerBambooAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerBambooAuthParamsDTO: + """Test DesignerBambooAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerBambooAuthParamsDTO` + """ + model = DesignerBambooAuthParamsDTO() + if include_optional: + return DesignerBambooAuthParamsDTO( + access_key = '', + tenant_domain_name = '' + ) + else: + return DesignerBambooAuthParamsDTO( + ) + """ + + def testDesignerBambooAuthParamsDTO(self): + """Test DesignerBambooAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_basic_s3_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_basic_s3_auth_params_dto.py new file mode 100644 index 0000000000..8b6b4faae9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_basic_s3_auth_params_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_basic_s3_auth_params_dto import DesignerBasicS3AuthParamsDTO + +class TestDesignerBasicS3AuthParamsDTO(unittest.TestCase): + """DesignerBasicS3AuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerBasicS3AuthParamsDTO: + """Test DesignerBasicS3AuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerBasicS3AuthParamsDTO` + """ + model = DesignerBasicS3AuthParamsDTO() + if include_optional: + return DesignerBasicS3AuthParamsDTO( + bucket_name = '', + bucket_region = '', + access_key = '', + secret_key = '', + path = '' + ) + else: + return DesignerBasicS3AuthParamsDTO( + ) + """ + + def testDesignerBasicS3AuthParamsDTO(self): + """Test DesignerBasicS3AuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_big_query_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_big_query_auth_params_dto.py new file mode 100644 index 0000000000..0b765b5341 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_big_query_auth_params_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_big_query_auth_params_dto import DesignerBigQueryAuthParamsDTO + +class TestDesignerBigQueryAuthParamsDTO(unittest.TestCase): + """DesignerBigQueryAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerBigQueryAuthParamsDTO: + """Test DesignerBigQueryAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerBigQueryAuthParamsDTO` + """ + model = DesignerBigQueryAuthParamsDTO() + if include_optional: + return DesignerBigQueryAuthParamsDTO( + project_id = '', + dataset_location = '', + refresh_token = '', + client_id = '', + client_secret = '', + default_dataset = '', + service_account_params = visier_platform_sdk.models.designer/big_query_service_account_params_dto.designer.BigQueryServiceAccountParamsDTO( + service_account_email = '', + private_key = '', ) + ) + else: + return DesignerBigQueryAuthParamsDTO( + ) + """ + + def testDesignerBigQueryAuthParamsDTO(self): + """Test DesignerBigQueryAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_big_query_service_account_params_dto.py b/src/visier_platform_sdk/test/test_designer_big_query_service_account_params_dto.py new file mode 100644 index 0000000000..4ee0cc3e69 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_big_query_service_account_params_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_big_query_service_account_params_dto import DesignerBigQueryServiceAccountParamsDTO + +class TestDesignerBigQueryServiceAccountParamsDTO(unittest.TestCase): + """DesignerBigQueryServiceAccountParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerBigQueryServiceAccountParamsDTO: + """Test DesignerBigQueryServiceAccountParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerBigQueryServiceAccountParamsDTO` + """ + model = DesignerBigQueryServiceAccountParamsDTO() + if include_optional: + return DesignerBigQueryServiceAccountParamsDTO( + service_account_email = '', + private_key = '' + ) + else: + return DesignerBigQueryServiceAccountParamsDTO( + ) + """ + + def testDesignerBigQueryServiceAccountParamsDTO(self): + """Test DesignerBigQueryServiceAccountParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_copy_s3_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_copy_s3_auth_params_dto.py new file mode 100644 index 0000000000..3cbbcc52cd --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_copy_s3_auth_params_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_copy_s3_auth_params_dto import DesignerCopyS3AuthParamsDTO + +class TestDesignerCopyS3AuthParamsDTO(unittest.TestCase): + """DesignerCopyS3AuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerCopyS3AuthParamsDTO: + """Test DesignerCopyS3AuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerCopyS3AuthParamsDTO` + """ + model = DesignerCopyS3AuthParamsDTO() + if include_optional: + return DesignerCopyS3AuthParamsDTO( + iam_role = '' + ) + else: + return DesignerCopyS3AuthParamsDTO( + ) + """ + + def testDesignerCopyS3AuthParamsDTO(self): + """Test DesignerCopyS3AuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_credential_creation_api_response_dto.py b/src/visier_platform_sdk/test/test_designer_credential_creation_api_response_dto.py new file mode 100644 index 0000000000..59e6164607 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_credential_creation_api_response_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_credential_creation_api_response_dto import DesignerCredentialCreationAPIResponseDTO + +class TestDesignerCredentialCreationAPIResponseDTO(unittest.TestCase): + """DesignerCredentialCreationAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerCredentialCreationAPIResponseDTO: + """Test DesignerCredentialCreationAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerCredentialCreationAPIResponseDTO` + """ + model = DesignerCredentialCreationAPIResponseDTO() + if include_optional: + return DesignerCredentialCreationAPIResponseDTO( + uuid = '', + symbol_name = '', + object_name = '', + missing_connection_properties = [ + visier_platform_sdk.models.designer/subject_missing_access_dto.designer.SubjectMissingAccessDTO( + subject = 'Employee', + attributes = [ + '' + ], + error_message = '', ) + ] + ) + else: + return DesignerCredentialCreationAPIResponseDTO( + ) + """ + + def testDesignerCredentialCreationAPIResponseDTO(self): + """Test DesignerCredentialCreationAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_crypto_generate_key_request_dto.py b/src/visier_platform_sdk/test/test_designer_crypto_generate_key_request_dto.py new file mode 100644 index 0000000000..71fd9eda8d --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_crypto_generate_key_request_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_crypto_generate_key_request_dto import DesignerCryptoGenerateKeyRequestDTO + +class TestDesignerCryptoGenerateKeyRequestDTO(unittest.TestCase): + """DesignerCryptoGenerateKeyRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerCryptoGenerateKeyRequestDTO: + """Test DesignerCryptoGenerateKeyRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerCryptoGenerateKeyRequestDTO` + """ + model = DesignerCryptoGenerateKeyRequestDTO() + if include_optional: + return DesignerCryptoGenerateKeyRequestDTO( + key_name = '', + expiry_date = '', + algorithm = '' + ) + else: + return DesignerCryptoGenerateKeyRequestDTO( + ) + """ + + def testDesignerCryptoGenerateKeyRequestDTO(self): + """Test DesignerCryptoGenerateKeyRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_crypto_key_pair_delete_response_dto.py b/src/visier_platform_sdk/test/test_designer_crypto_key_pair_delete_response_dto.py new file mode 100644 index 0000000000..021028b162 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_crypto_key_pair_delete_response_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_crypto_key_pair_delete_response_dto import DesignerCryptoKeyPairDeleteResponseDTO + +class TestDesignerCryptoKeyPairDeleteResponseDTO(unittest.TestCase): + """DesignerCryptoKeyPairDeleteResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerCryptoKeyPairDeleteResponseDTO: + """Test DesignerCryptoKeyPairDeleteResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerCryptoKeyPairDeleteResponseDTO` + """ + model = DesignerCryptoKeyPairDeleteResponseDTO() + if include_optional: + return DesignerCryptoKeyPairDeleteResponseDTO( + key_id = '' + ) + else: + return DesignerCryptoKeyPairDeleteResponseDTO( + ) + """ + + def testDesignerCryptoKeyPairDeleteResponseDTO(self): + """Test DesignerCryptoKeyPairDeleteResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_crypto_key_pair_generate_request_dto.py b/src/visier_platform_sdk/test/test_designer_crypto_key_pair_generate_request_dto.py new file mode 100644 index 0000000000..a050bcd598 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_crypto_key_pair_generate_request_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_crypto_key_pair_generate_request_dto import DesignerCryptoKeyPairGenerateRequestDTO + +class TestDesignerCryptoKeyPairGenerateRequestDTO(unittest.TestCase): + """DesignerCryptoKeyPairGenerateRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerCryptoKeyPairGenerateRequestDTO: + """Test DesignerCryptoKeyPairGenerateRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerCryptoKeyPairGenerateRequestDTO` + """ + model = DesignerCryptoKeyPairGenerateRequestDTO() + if include_optional: + return DesignerCryptoKeyPairGenerateRequestDTO( + expiration_date = '' + ) + else: + return DesignerCryptoKeyPairGenerateRequestDTO( + ) + """ + + def testDesignerCryptoKeyPairGenerateRequestDTO(self): + """Test DesignerCryptoKeyPairGenerateRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_crypto_public_key_dto.py b/src/visier_platform_sdk/test/test_designer_crypto_public_key_dto.py new file mode 100644 index 0000000000..97c4830b38 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_crypto_public_key_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_crypto_public_key_dto import DesignerCryptoPublicKeyDTO + +class TestDesignerCryptoPublicKeyDTO(unittest.TestCase): + """DesignerCryptoPublicKeyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerCryptoPublicKeyDTO: + """Test DesignerCryptoPublicKeyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerCryptoPublicKeyDTO` + """ + model = DesignerCryptoPublicKeyDTO() + if include_optional: + return DesignerCryptoPublicKeyDTO( + key_id = '', + date_generated = '', + expiry_date = '', + recipient = '', + public_key = '' + ) + else: + return DesignerCryptoPublicKeyDTO( + ) + """ + + def testDesignerCryptoPublicKeyDTO(self): + """Test DesignerCryptoPublicKeyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_crypto_public_keys_dto.py b/src/visier_platform_sdk/test/test_designer_crypto_public_keys_dto.py new file mode 100644 index 0000000000..763cf92e51 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_crypto_public_keys_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_crypto_public_keys_dto import DesignerCryptoPublicKeysDTO + +class TestDesignerCryptoPublicKeysDTO(unittest.TestCase): + """DesignerCryptoPublicKeysDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerCryptoPublicKeysDTO: + """Test DesignerCryptoPublicKeysDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerCryptoPublicKeysDTO` + """ + model = DesignerCryptoPublicKeysDTO() + if include_optional: + return DesignerCryptoPublicKeysDTO( + keys = [ + visier_platform_sdk.models.designer/crypto/public_key_dto.designer.crypto.PublicKeyDTO( + key_id = '', + date_generated = '', + expiry_date = '', + recipient = '', + public_key = '', ) + ] + ) + else: + return DesignerCryptoPublicKeysDTO( + ) + """ + + def testDesignerCryptoPublicKeysDTO(self): + """Test DesignerCryptoPublicKeysDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_crypto_tenant_encryption_key_details_dto.py b/src/visier_platform_sdk/test/test_designer_crypto_tenant_encryption_key_details_dto.py new file mode 100644 index 0000000000..07a010a94e --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_crypto_tenant_encryption_key_details_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_crypto_tenant_encryption_key_details_dto import DesignerCryptoTenantEncryptionKeyDetailsDTO + +class TestDesignerCryptoTenantEncryptionKeyDetailsDTO(unittest.TestCase): + """DesignerCryptoTenantEncryptionKeyDetailsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerCryptoTenantEncryptionKeyDetailsDTO: + """Test DesignerCryptoTenantEncryptionKeyDetailsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerCryptoTenantEncryptionKeyDetailsDTO` + """ + model = DesignerCryptoTenantEncryptionKeyDetailsDTO() + if include_optional: + return DesignerCryptoTenantEncryptionKeyDetailsDTO( + key_name = '', + algorithm = '', + generated_by = '', + date_generated = '', + expiry_date = '' + ) + else: + return DesignerCryptoTenantEncryptionKeyDetailsDTO( + ) + """ + + def testDesignerCryptoTenantEncryptionKeyDetailsDTO(self): + """Test DesignerCryptoTenantEncryptionKeyDetailsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_crypto_tenant_encryption_key_dto.py b/src/visier_platform_sdk/test/test_designer_crypto_tenant_encryption_key_dto.py new file mode 100644 index 0000000000..d0fcb32ce1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_crypto_tenant_encryption_key_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_crypto_tenant_encryption_key_dto import DesignerCryptoTenantEncryptionKeyDTO + +class TestDesignerCryptoTenantEncryptionKeyDTO(unittest.TestCase): + """DesignerCryptoTenantEncryptionKeyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerCryptoTenantEncryptionKeyDTO: + """Test DesignerCryptoTenantEncryptionKeyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerCryptoTenantEncryptionKeyDTO` + """ + model = DesignerCryptoTenantEncryptionKeyDTO() + if include_optional: + return DesignerCryptoTenantEncryptionKeyDTO( + detail = visier_platform_sdk.models.designer/crypto/tenant_encryption_key_details_dto.designer.crypto.TenantEncryptionKeyDetailsDTO( + key_name = '', + algorithm = '', + generated_by = '', + date_generated = '', + expiry_date = '', ), + key = '' + ) + else: + return DesignerCryptoTenantEncryptionKeyDTO( + ) + """ + + def testDesignerCryptoTenantEncryptionKeyDTO(self): + """Test DesignerCryptoTenantEncryptionKeyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_provider_auth_information_dto.py b/src/visier_platform_sdk/test/test_designer_data_provider_auth_information_dto.py new file mode 100644 index 0000000000..488f7f660e --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_provider_auth_information_dto.py @@ -0,0 +1,257 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_provider_auth_information_dto import DesignerDataProviderAuthInformationDTO + +class TestDesignerDataProviderAuthInformationDTO(unittest.TestCase): + """DesignerDataProviderAuthInformationDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataProviderAuthInformationDTO: + """Test DesignerDataProviderAuthInformationDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataProviderAuthInformationDTO` + """ + model = DesignerDataProviderAuthInformationDTO() + if include_optional: + return DesignerDataProviderAuthInformationDTO( + data_provider_auth_params = visier_platform_sdk.models.designer/data_provider_auth_params_dto.designer.DataProviderAuthParamsDTO( + tenant_domain_name = '', + provider = 'Bamboo', + bamboo_auth_params = visier_platform_sdk.models.designer/bamboo_auth_params_dto.designer.BambooAuthParamsDTO( + access_key = '', + tenant_domain_name = '', ), + greenhouse_auth_params = visier_platform_sdk.models.designer/greenhouse_auth_params_dto.designer.GreenhouseAuthParamsDTO( + api_key = '', ), + google_sheets_auth_params = visier_platform_sdk.models.designer/google_sheets_auth_params_dto.designer.GoogleSheetsAuthParamsDTO( + auth_code = '', + configuration = '', + client_id = '', + client_secret = '', ), + jira_auth_params = visier_platform_sdk.models.designer/jira_auth_params_dto.designer.JiraAuthParamsDTO( + api_token = '', + host_name = '', + connect_params = visier_platform_sdk.models.designer/jira_connect_params_dto.designer.JiraConnectParamsDTO( + app_key = '', + client_key = '', + shared_secret = '', ), ), + lever_auth_params = visier_platform_sdk.models.designer/lever_auth_params_dto.designer.LeverAuthParamsDTO( + api_key = '', ), + namely_auth_params = visier_platform_sdk.models.designer/namely_auth_params_dto.designer.NamelyAuthParamsDTO( + auth_code = '', ), + qualtrics_auth_params = visier_platform_sdk.models.designer/qualtrics_auth_params_dto.designer.QualtricsAuthParamsDTO( + api_token = '', + data_center_id = '', ), + salesforce_auth_params = visier_platform_sdk.models.designer/salesforce_auth_params_dto.designer.SalesforceAuthParamsDTO( + refresh_token = '', + client_id = '', ), + ultimate_auth_params = visier_platform_sdk.models.designer/ultimate_auth_params_dto.designer.UltimateAuthParamsDTO( + host_domain_name = '', + api_key = '', + username = '', + password = '', + user_access_key = '', ), + workday_auth_params = visier_platform_sdk.models.designer/workday_auth_params_dto.designer.WorkdayAuthParamsDTO( + user_id = '', + domain_name = '', + implementation_name = '', + password = '', + o_auth = visier_platform_sdk.models.designer/workday_o_auth_params_dto.designer.WorkdayOAuthParamsDTO( + api_client_id = '', + public_x509_cert = '', + private_x509_key = '', ), + ref_token = visier_platform_sdk.models.designer/workday_refresh_token_params_dto.designer.WorkdayRefreshTokenParamsDTO( + api_client_id = '', + client_secret = '', + refresh_token = '', ), + integration_system_id = '', + api_key = '', ), + icims_auth_params = visier_platform_sdk.models.designer/icims_auth_params_dto.designer.IcimsAuthParamsDTO( + customer_id = '', + username = '', + password = '', + client_id = '', + client_secret = '', + region = 'US', ), + service_now_auth_params = visier_platform_sdk.models.designer/service_now_auth_params_dto.designer.ServiceNowAuthParamsDTO( + host_domain_name = '', + username = '', + password = '', ), + jdbc_auth_params = visier_platform_sdk.models.designer/jdbc_auth_params_dto.designer.JdbcAuthParamsDTO( + jdbc_connect_string = '', + username = '', + password = '', ), + s3_auth_params = visier_platform_sdk.models.designer/basic_s3_auth_params_dto.designer.BasicS3AuthParamsDTO( + bucket_name = '', + bucket_region = '', + access_key = '', + secret_key = '', + path = '', ), + internal_s3_auth_params = visier_platform_sdk.models.designer/internal_s3_auth_params_dto.designer.InternalS3AuthParamsDTO( + bucket_name = '', + path = '', ), + copy_s3_auth_params = visier_platform_sdk.models.designer/copy_s3_auth_params_dto.designer.CopyS3AuthParamsDTO( + iam_role = '', ), + redshift_auth_params = visier_platform_sdk.models.designer/redshift_auth_params_dto.designer.RedshiftAuthParamsDTO( + endpoint = '', + port = '', + database = '', + username = '', + password = '', + table_prefix = '', + schema = '', ), + snowflake_auth_params = visier_platform_sdk.models.designer/snowflake_auth_params_dto.designer.SnowflakeAuthParamsDTO( + account_identifier = '', + database = '', + schema = '', + username = '', + password = '', + warehouse = '', + private_key = '', ), + big_query_auth_params = visier_platform_sdk.models.designer/big_query_auth_params_dto.designer.BigQueryAuthParamsDTO( + project_id = '', + dataset_location = '', + refresh_token = '', + client_id = '', + client_secret = '', + default_dataset = '', + service_account_params = visier_platform_sdk.models.designer/big_query_service_account_params_dto.designer.BigQueryServiceAccountParamsDTO( + service_account_email = '', + private_key = '', ), ), + sql_server_auth_params = visier_platform_sdk.models.designer/sql_server_auth_params_dto.designer.SqlServerAuthParamsDTO( + host = '', + port = '', + username = '', + password = '', + database = '', ), + dimensions_auth_params = visier_platform_sdk.models.designer/dimensions_auth_params_dto.designer.DimensionsAuthParamsDTO( + app_key = '', + client_id = '', + client_secret = '', + vanity_url = '', + username = '', + password = '', ), + willow_auth_params = visier_platform_sdk.models.designer/willow_auth_params_dto.designer.WillowAuthParamsDTO( + api_token = '', + host_name = '', ), + empty_auth_params = visier_platform_sdk.models.designer/empty_auth_params_dto.designer.EmptyAuthParamsDTO(), + success_factors_auth_params = visier_platform_sdk.models.designer/success_factors_auth_params_dto.designer.SuccessFactorsAuthParamsDTO( + host_domain_name = '', + company_id = '', + username = '', + password = '', ), + fusion_auth_params = visier_platform_sdk.models.designer/fusion_auth_params_dto.designer.FusionAuthParamsDTO( + username = '', + password = '', + host_domain_name = '', ), + adp_auth_params = visier_platform_sdk.models.designer/adp_auth_params_dto.designer.AdpAuthParamsDTO( + auth_code = '', ), + medallia_auth_params = visier_platform_sdk.models.designer/medallia_auth_params_dto.designer.MedalliaAuthParamsDTO( + tenant_domain_name = '', + instance_url = '', + client_id = '', + client_secret = '', ), + salesforce_v2_auth_params = visier_platform_sdk.models.designer/salesforce_v2_auth_params_dto.designer.SalesforceV2AuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '', + login_host = '', ), + gong_auth_params = visier_platform_sdk.models.designer/gong_auth_params_dto.designer.GongAuthParamsDTO( + client_id = '', + client_secret = '', ), + zoom_auth_params = visier_platform_sdk.models.designer/zoom_auth_params_dto.designer.ZoomAuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '', ), + dayforce_v2_auth_params = visier_platform_sdk.models.designer/dayforce_v2_auth_params_dto.designer.DayforceV2AuthParamsDTO( + username = '', + password = '', + company_id = '', + token_host = '', + host_domain_name = '', ), + slack_auth_params = visier_platform_sdk.models.designer/slack_auth_params_dto.designer.SlackAuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '', ), + my_sql_auth_params = visier_platform_sdk.models.designer/my_sql_auth_params_dto.designer.MySqlAuthParamsDTO( + host = '', + port = '', + username = '', + password = '', + database = '', + ssl_mode = '', ), + workday_raas_auth_params = visier_platform_sdk.models.designer/workday_raas_auth_params_dto.designer.WorkdayRaasAuthParamsDTO( + user_id = '', + domain_name = '', + implementation_name = '', + password = '', + test_report_url = '', ), + ms365_auth_params = visier_platform_sdk.models.designer/microsoft365_auth_params_dto.designer.Microsoft365AuthParamsDTO( + o_auth_tenant_id = '', + client_id = '', + client_secret = '', + privacy_mode = '', ), + google_workspace_auth_params = visier_platform_sdk.models.designer/google_workspace_auth_params_dto.designer.GoogleWorkspaceAuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '', + service_account = '', + privacy_mode = '', ), + oracle_db_auth_params = visier_platform_sdk.models.designer/oracle_db_auth_params_dto.designer.OracleDbAuthParamsDTO( + host = '', + port = '', + username = '', + password = '', + service_name = '', ), + service_now_v2_auth_params = visier_platform_sdk.models.designer/service_now_v2_auth_params_dto.designer.ServiceNowV2AuthParamsDTO( + host_domain_name = '', + client_id = '', + client_secret = '', + auth_code = '', + alternate_domain = '', ), + databricks_auth_params = visier_platform_sdk.models.designer/databricks_auth_params_dto.designer.DatabricksAuthParamsDTO( + share_credentials_version = '', + bearer_token = '', + endpoint = '', + expiration_time = '', ), + has_updates = True, + auth_context = 'DefaultDataExtraction', ), + data_provider_basic_information = visier_platform_sdk.models.designer/data_provider_basic_information_dto.designer.DataProviderBasicInformationDTO( + display_name = '', + description = '', ), + data_provider_metadata = visier_platform_sdk.models.designer/data_provider_basic_metadata_dto.designer.DataProviderBasicMetadataDTO( + can_children_inherit = True, ) + ) + else: + return DesignerDataProviderAuthInformationDTO( + ) + """ + + def testDesignerDataProviderAuthInformationDTO(self): + """Test DesignerDataProviderAuthInformationDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_provider_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_data_provider_auth_params_dto.py new file mode 100644 index 0000000000..6aaf047f6d --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_provider_auth_params_dto.py @@ -0,0 +1,255 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_provider_auth_params_dto import DesignerDataProviderAuthParamsDTO + +class TestDesignerDataProviderAuthParamsDTO(unittest.TestCase): + """DesignerDataProviderAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataProviderAuthParamsDTO: + """Test DesignerDataProviderAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataProviderAuthParamsDTO` + """ + model = DesignerDataProviderAuthParamsDTO() + if include_optional: + return DesignerDataProviderAuthParamsDTO( + tenant_domain_name = '', + provider = 'Bamboo', + bamboo_auth_params = visier_platform_sdk.models.designer/bamboo_auth_params_dto.designer.BambooAuthParamsDTO( + access_key = '', + tenant_domain_name = '', ), + greenhouse_auth_params = visier_platform_sdk.models.designer/greenhouse_auth_params_dto.designer.GreenhouseAuthParamsDTO( + api_key = '', ), + google_sheets_auth_params = visier_platform_sdk.models.designer/google_sheets_auth_params_dto.designer.GoogleSheetsAuthParamsDTO( + auth_code = '', + configuration = '', + client_id = '', + client_secret = '', ), + jira_auth_params = visier_platform_sdk.models.designer/jira_auth_params_dto.designer.JiraAuthParamsDTO( + api_token = '', + host_name = '', + connect_params = visier_platform_sdk.models.designer/jira_connect_params_dto.designer.JiraConnectParamsDTO( + app_key = '', + client_key = '', + shared_secret = '', ), ), + lever_auth_params = visier_platform_sdk.models.designer/lever_auth_params_dto.designer.LeverAuthParamsDTO( + api_key = '', ), + namely_auth_params = visier_platform_sdk.models.designer/namely_auth_params_dto.designer.NamelyAuthParamsDTO( + auth_code = '', ), + qualtrics_auth_params = visier_platform_sdk.models.designer/qualtrics_auth_params_dto.designer.QualtricsAuthParamsDTO( + api_token = '', + data_center_id = '', ), + salesforce_auth_params = visier_platform_sdk.models.designer/salesforce_auth_params_dto.designer.SalesforceAuthParamsDTO( + refresh_token = '', + client_id = '', ), + ultimate_auth_params = visier_platform_sdk.models.designer/ultimate_auth_params_dto.designer.UltimateAuthParamsDTO( + host_domain_name = '', + api_key = '', + username = '', + password = '', + user_access_key = '', ), + workday_auth_params = visier_platform_sdk.models.designer/workday_auth_params_dto.designer.WorkdayAuthParamsDTO( + user_id = '', + domain_name = '', + implementation_name = '', + password = '', + o_auth = visier_platform_sdk.models.designer/workday_o_auth_params_dto.designer.WorkdayOAuthParamsDTO( + api_client_id = '', + public_x509_cert = '', + private_x509_key = '', ), + ref_token = visier_platform_sdk.models.designer/workday_refresh_token_params_dto.designer.WorkdayRefreshTokenParamsDTO( + api_client_id = '', + client_secret = '', + refresh_token = '', ), + integration_system_id = '', + api_key = '', ), + icims_auth_params = visier_platform_sdk.models.designer/icims_auth_params_dto.designer.IcimsAuthParamsDTO( + customer_id = '', + username = '', + password = '', + client_id = '', + client_secret = '', + region = 'US', ), + service_now_auth_params = visier_platform_sdk.models.designer/service_now_auth_params_dto.designer.ServiceNowAuthParamsDTO( + host_domain_name = '', + username = '', + password = '', ), + jdbc_auth_params = visier_platform_sdk.models.designer/jdbc_auth_params_dto.designer.JdbcAuthParamsDTO( + jdbc_connect_string = '', + username = '', + password = '', ), + s3_auth_params = visier_platform_sdk.models.designer/basic_s3_auth_params_dto.designer.BasicS3AuthParamsDTO( + bucket_name = '', + bucket_region = '', + access_key = '', + secret_key = '', + path = '', ), + internal_s3_auth_params = visier_platform_sdk.models.designer/internal_s3_auth_params_dto.designer.InternalS3AuthParamsDTO( + bucket_name = '', + path = '', ), + copy_s3_auth_params = visier_platform_sdk.models.designer/copy_s3_auth_params_dto.designer.CopyS3AuthParamsDTO( + iam_role = '', ), + redshift_auth_params = visier_platform_sdk.models.designer/redshift_auth_params_dto.designer.RedshiftAuthParamsDTO( + endpoint = '', + port = '', + database = '', + username = '', + password = '', + table_prefix = '', + schema = '', ), + snowflake_auth_params = visier_platform_sdk.models.designer/snowflake_auth_params_dto.designer.SnowflakeAuthParamsDTO( + account_identifier = '', + database = '', + schema = '', + username = '', + password = '', + warehouse = '', + private_key = '', ), + big_query_auth_params = visier_platform_sdk.models.designer/big_query_auth_params_dto.designer.BigQueryAuthParamsDTO( + project_id = '', + dataset_location = '', + refresh_token = '', + client_id = '', + client_secret = '', + default_dataset = '', + service_account_params = visier_platform_sdk.models.designer/big_query_service_account_params_dto.designer.BigQueryServiceAccountParamsDTO( + service_account_email = '', + private_key = '', ), ), + sql_server_auth_params = visier_platform_sdk.models.designer/sql_server_auth_params_dto.designer.SqlServerAuthParamsDTO( + host = '', + port = '', + username = '', + password = '', + database = '', ), + dimensions_auth_params = visier_platform_sdk.models.designer/dimensions_auth_params_dto.designer.DimensionsAuthParamsDTO( + app_key = '', + client_id = '', + client_secret = '', + vanity_url = '', + username = '', + password = '', ), + willow_auth_params = visier_platform_sdk.models.designer/willow_auth_params_dto.designer.WillowAuthParamsDTO( + api_token = '', + host_name = '', ), + empty_auth_params = visier_platform_sdk.models.designer/empty_auth_params_dto.designer.EmptyAuthParamsDTO(), + success_factors_auth_params = visier_platform_sdk.models.designer/success_factors_auth_params_dto.designer.SuccessFactorsAuthParamsDTO( + host_domain_name = '', + company_id = '', + username = '', + password = '', + o_auth = visier_platform_sdk.models.designer/success_factors_o_auth_params_dto.designer.SuccessFactorsOAuthParamsDTO( + api_key = '', + private_x509_key = '', + public_x509_cert = '', ), ), + fusion_auth_params = visier_platform_sdk.models.designer/fusion_auth_params_dto.designer.FusionAuthParamsDTO( + username = '', + password = '', + host_domain_name = '', ), + adp_auth_params = visier_platform_sdk.models.designer/adp_auth_params_dto.designer.AdpAuthParamsDTO( + auth_code = '', ), + medallia_auth_params = visier_platform_sdk.models.designer/medallia_auth_params_dto.designer.MedalliaAuthParamsDTO( + tenant_domain_name = '', + instance_url = '', + client_id = '', + client_secret = '', ), + salesforce_v2_auth_params = visier_platform_sdk.models.designer/salesforce_v2_auth_params_dto.designer.SalesforceV2AuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '', + login_host = '', ), + gong_auth_params = visier_platform_sdk.models.designer/gong_auth_params_dto.designer.GongAuthParamsDTO( + client_id = '', + client_secret = '', ), + zoom_auth_params = visier_platform_sdk.models.designer/zoom_auth_params_dto.designer.ZoomAuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '', ), + dayforce_v2_auth_params = visier_platform_sdk.models.designer/dayforce_v2_auth_params_dto.designer.DayforceV2AuthParamsDTO( + username = '', + password = '', + company_id = '', + token_host = '', + host_domain_name = '', ), + slack_auth_params = visier_platform_sdk.models.designer/slack_auth_params_dto.designer.SlackAuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '', ), + my_sql_auth_params = visier_platform_sdk.models.designer/my_sql_auth_params_dto.designer.MySqlAuthParamsDTO( + host = '', + port = '', + username = '', + password = '', + database = '', + ssl_mode = '', ), + workday_raas_auth_params = visier_platform_sdk.models.designer/workday_raas_auth_params_dto.designer.WorkdayRaasAuthParamsDTO( + user_id = '', + domain_name = '', + implementation_name = '', + password = '', + test_report_url = '', ), + ms365_auth_params = visier_platform_sdk.models.designer/microsoft365_auth_params_dto.designer.Microsoft365AuthParamsDTO( + o_auth_tenant_id = '', + client_id = '', + client_secret = '', + privacy_mode = '', ), + google_workspace_auth_params = visier_platform_sdk.models.designer/google_workspace_auth_params_dto.designer.GoogleWorkspaceAuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '', + service_account = '', + privacy_mode = '', ), + oracle_db_auth_params = visier_platform_sdk.models.designer/oracle_db_auth_params_dto.designer.OracleDbAuthParamsDTO( + host = '', + port = '', + username = '', + password = '', + service_name = '', ), + service_now_v2_auth_params = visier_platform_sdk.models.designer/service_now_v2_auth_params_dto.designer.ServiceNowV2AuthParamsDTO( + host_domain_name = '', + client_id = '', + client_secret = '', + auth_code = '', + alternate_domain = '', ), + databricks_auth_params = visier_platform_sdk.models.designer/databricks_auth_params_dto.designer.DatabricksAuthParamsDTO( + share_credentials_version = '', + bearer_token = '', + endpoint = '', + expiration_time = '', ), + has_updates = True, + auth_context = 'DefaultDataExtraction' + ) + else: + return DesignerDataProviderAuthParamsDTO( + ) + """ + + def testDesignerDataProviderAuthParamsDTO(self): + """Test DesignerDataProviderAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_provider_basic_information_dto.py b/src/visier_platform_sdk/test/test_designer_data_provider_basic_information_dto.py new file mode 100644 index 0000000000..719083573e --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_provider_basic_information_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_provider_basic_information_dto import DesignerDataProviderBasicInformationDTO + +class TestDesignerDataProviderBasicInformationDTO(unittest.TestCase): + """DesignerDataProviderBasicInformationDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataProviderBasicInformationDTO: + """Test DesignerDataProviderBasicInformationDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataProviderBasicInformationDTO` + """ + model = DesignerDataProviderBasicInformationDTO() + if include_optional: + return DesignerDataProviderBasicInformationDTO( + display_name = '', + description = '' + ) + else: + return DesignerDataProviderBasicInformationDTO( + ) + """ + + def testDesignerDataProviderBasicInformationDTO(self): + """Test DesignerDataProviderBasicInformationDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_provider_basic_metadata_dto.py b/src/visier_platform_sdk/test/test_designer_data_provider_basic_metadata_dto.py new file mode 100644 index 0000000000..c89837402d --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_provider_basic_metadata_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_provider_basic_metadata_dto import DesignerDataProviderBasicMetadataDTO + +class TestDesignerDataProviderBasicMetadataDTO(unittest.TestCase): + """DesignerDataProviderBasicMetadataDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataProviderBasicMetadataDTO: + """Test DesignerDataProviderBasicMetadataDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataProviderBasicMetadataDTO` + """ + model = DesignerDataProviderBasicMetadataDTO() + if include_optional: + return DesignerDataProviderBasicMetadataDTO( + can_children_inherit = True + ) + else: + return DesignerDataProviderBasicMetadataDTO( + ) + """ + + def testDesignerDataProviderBasicMetadataDTO(self): + """Test DesignerDataProviderBasicMetadataDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_export_column_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_export_column_dto.py new file mode 100644 index 0000000000..dd334f7169 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_export_column_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_export_column_dto import DesignerDataVersionExportColumnDTO + +class TestDesignerDataVersionExportColumnDTO(unittest.TestCase): + """DesignerDataVersionExportColumnDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportColumnDTO: + """Test DesignerDataVersionExportColumnDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportColumnDTO` + """ + model = DesignerDataVersionExportColumnDTO() + if include_optional: + return DesignerDataVersionExportColumnDTO( + name = '', + data_type = '', + allows_null = True, + is_primary_key_component = True + ) + else: + return DesignerDataVersionExportColumnDTO( + ) + """ + + def testDesignerDataVersionExportColumnDTO(self): + """Test DesignerDataVersionExportColumnDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_export_data_version_summary_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_export_data_version_summary_dto.py new file mode 100644 index 0000000000..5840d813f3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_export_data_version_summary_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_export_data_version_summary_dto import DesignerDataVersionExportDataVersionSummaryDTO + +class TestDesignerDataVersionExportDataVersionSummaryDTO(unittest.TestCase): + """DesignerDataVersionExportDataVersionSummaryDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportDataVersionSummaryDTO: + """Test DesignerDataVersionExportDataVersionSummaryDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportDataVersionSummaryDTO` + """ + model = DesignerDataVersionExportDataVersionSummaryDTO() + if include_optional: + return DesignerDataVersionExportDataVersionSummaryDTO( + data_version = '', + data_category = '', + created = '' + ) + else: + return DesignerDataVersionExportDataVersionSummaryDTO( + ) + """ + + def testDesignerDataVersionExportDataVersionSummaryDTO(self): + """Test DesignerDataVersionExportDataVersionSummaryDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_export_data_versions_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_export_data_versions_dto.py new file mode 100644 index 0000000000..3441a72bd9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_export_data_versions_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_export_data_versions_dto import DesignerDataVersionExportDataVersionsDTO + +class TestDesignerDataVersionExportDataVersionsDTO(unittest.TestCase): + """DesignerDataVersionExportDataVersionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportDataVersionsDTO: + """Test DesignerDataVersionExportDataVersionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportDataVersionsDTO` + """ + model = DesignerDataVersionExportDataVersionsDTO() + if include_optional: + return DesignerDataVersionExportDataVersionsDTO( + data_versions = [ + visier_platform_sdk.models.designer/data_version_export_data_version_summary_dto.designer.DataVersionExportDataVersionSummaryDTO( + data_version = '', + data_category = '', + created = '', ) + ] + ) + else: + return DesignerDataVersionExportDataVersionsDTO( + ) + """ + + def testDesignerDataVersionExportDataVersionsDTO(self): + """Test DesignerDataVersionExportDataVersionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_export_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_export_dto.py new file mode 100644 index 0000000000..52824c8919 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_export_dto.py @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_export_dto import DesignerDataVersionExportDTO + +class TestDesignerDataVersionExportDTO(unittest.TestCase): + """DesignerDataVersionExportDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportDTO: + """Test DesignerDataVersionExportDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportDTO` + """ + model = DesignerDataVersionExportDTO() + if include_optional: + return DesignerDataVersionExportDTO( + uuid = '', + timestamp = '', + data_version_number = '', + base_data_version_number = '', + tables = [ + visier_platform_sdk.models.designer/data_version_export_table_dto.designer.DataVersionExportTableDTO( + name = '', + common_columns = None, + new_columns = None, + deleted_columns = [ + '' + ], ) + ], + new_tables = [ + '' + ], + deleted_tables = [ + '' + ] + ) + else: + return DesignerDataVersionExportDTO( + ) + """ + + def testDesignerDataVersionExportDTO(self): + """Test DesignerDataVersionExportDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_export_file_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_export_file_dto.py new file mode 100644 index 0000000000..b58c0f6f52 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_export_file_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_export_file_dto import DesignerDataVersionExportFileDTO + +class TestDesignerDataVersionExportFileDTO(unittest.TestCase): + """DesignerDataVersionExportFileDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportFileDTO: + """Test DesignerDataVersionExportFileDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportFileDTO` + """ + model = DesignerDataVersionExportFileDTO() + if include_optional: + return DesignerDataVersionExportFileDTO( + columns = [ + visier_platform_sdk.models.designer/data_version_export_column_dto.designer.DataVersionExportColumnDTO( + name = '', + data_type = '', + allows_null = True, + is_primary_key_component = True, ) + ], + files = [ + visier_platform_sdk.models.designer/data_version_export_part_file_dto.designer.DataVersionExportPartFileDTO( + file_id = 56, + filename = '', ) + ] + ) + else: + return DesignerDataVersionExportFileDTO( + ) + """ + + def testDesignerDataVersionExportFileDTO(self): + """Test DesignerDataVersionExportFileDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_export_job_status_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_export_job_status_dto.py new file mode 100644 index 0000000000..f089e06306 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_export_job_status_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_export_job_status_dto import DesignerDataVersionExportJobStatusDTO + +class TestDesignerDataVersionExportJobStatusDTO(unittest.TestCase): + """DesignerDataVersionExportJobStatusDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportJobStatusDTO: + """Test DesignerDataVersionExportJobStatusDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportJobStatusDTO` + """ + model = DesignerDataVersionExportJobStatusDTO() + if include_optional: + return DesignerDataVersionExportJobStatusDTO( + job_uuid = '', + completed = True, + failed = True, + export_uuid = '' + ) + else: + return DesignerDataVersionExportJobStatusDTO( + ) + """ + + def testDesignerDataVersionExportJobStatusDTO(self): + """Test DesignerDataVersionExportJobStatusDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_export_part_file_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_export_part_file_dto.py new file mode 100644 index 0000000000..39a4e4a429 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_export_part_file_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_export_part_file_dto import DesignerDataVersionExportPartFileDTO + +class TestDesignerDataVersionExportPartFileDTO(unittest.TestCase): + """DesignerDataVersionExportPartFileDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportPartFileDTO: + """Test DesignerDataVersionExportPartFileDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportPartFileDTO` + """ + model = DesignerDataVersionExportPartFileDTO() + if include_optional: + return DesignerDataVersionExportPartFileDTO( + file_id = 56, + filename = '' + ) + else: + return DesignerDataVersionExportPartFileDTO( + ) + """ + + def testDesignerDataVersionExportPartFileDTO(self): + """Test DesignerDataVersionExportPartFileDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_export_schedule_job_request_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_export_schedule_job_request_dto.py new file mode 100644 index 0000000000..8040646fd6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_export_schedule_job_request_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_export_schedule_job_request_dto import DesignerDataVersionExportScheduleJobRequestDTO + +class TestDesignerDataVersionExportScheduleJobRequestDTO(unittest.TestCase): + """DesignerDataVersionExportScheduleJobRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportScheduleJobRequestDTO: + """Test DesignerDataVersionExportScheduleJobRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportScheduleJobRequestDTO` + """ + model = DesignerDataVersionExportScheduleJobRequestDTO() + if include_optional: + return DesignerDataVersionExportScheduleJobRequestDTO( + data_version_number = '', + base_data_version_number = '' + ) + else: + return DesignerDataVersionExportScheduleJobRequestDTO( + ) + """ + + def testDesignerDataVersionExportScheduleJobRequestDTO(self): + """Test DesignerDataVersionExportScheduleJobRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_export_schedule_job_response_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_export_schedule_job_response_dto.py new file mode 100644 index 0000000000..79dd6eb723 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_export_schedule_job_response_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_export_schedule_job_response_dto import DesignerDataVersionExportScheduleJobResponseDTO + +class TestDesignerDataVersionExportScheduleJobResponseDTO(unittest.TestCase): + """DesignerDataVersionExportScheduleJobResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportScheduleJobResponseDTO: + """Test DesignerDataVersionExportScheduleJobResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportScheduleJobResponseDTO` + """ + model = DesignerDataVersionExportScheduleJobResponseDTO() + if include_optional: + return DesignerDataVersionExportScheduleJobResponseDTO( + job_uuid = '' + ) + else: + return DesignerDataVersionExportScheduleJobResponseDTO( + ) + """ + + def testDesignerDataVersionExportScheduleJobResponseDTO(self): + """Test DesignerDataVersionExportScheduleJobResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_export_table_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_export_table_dto.py new file mode 100644 index 0000000000..c82f690691 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_export_table_dto.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_export_table_dto import DesignerDataVersionExportTableDTO + +class TestDesignerDataVersionExportTableDTO(unittest.TestCase): + """DesignerDataVersionExportTableDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportTableDTO: + """Test DesignerDataVersionExportTableDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportTableDTO` + """ + model = DesignerDataVersionExportTableDTO() + if include_optional: + return DesignerDataVersionExportTableDTO( + name = '', + common_columns = visier_platform_sdk.models.designer/data_version_export_file_dto.designer.DataVersionExportFileDTO( + columns = [ + visier_platform_sdk.models.designer/data_version_export_column_dto.designer.DataVersionExportColumnDTO( + name = '', + data_type = '', + allows_null = True, + is_primary_key_component = True, ) + ], + files = [ + visier_platform_sdk.models.designer/data_version_export_part_file_dto.designer.DataVersionExportPartFileDTO( + file_id = 56, + filename = '', ) + ], ), + new_columns = visier_platform_sdk.models.designer/data_version_export_file_dto.designer.DataVersionExportFileDTO( + columns = [ + visier_platform_sdk.models.designer/data_version_export_column_dto.designer.DataVersionExportColumnDTO( + name = '', + data_type = '', + allows_null = True, + is_primary_key_component = True, ) + ], + files = [ + visier_platform_sdk.models.designer/data_version_export_part_file_dto.designer.DataVersionExportPartFileDTO( + file_id = 56, + filename = '', ) + ], ), + deleted_columns = [ + '' + ] + ) + else: + return DesignerDataVersionExportTableDTO( + ) + """ + + def testDesignerDataVersionExportTableDTO(self): + """Test DesignerDataVersionExportTableDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_data_version_exports_dto.py b/src/visier_platform_sdk/test/test_designer_data_version_exports_dto.py new file mode 100644 index 0000000000..3c73f0ad93 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_data_version_exports_dto.py @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_data_version_exports_dto import DesignerDataVersionExportsDTO + +class TestDesignerDataVersionExportsDTO(unittest.TestCase): + """DesignerDataVersionExportsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDataVersionExportsDTO: + """Test DesignerDataVersionExportsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDataVersionExportsDTO` + """ + model = DesignerDataVersionExportsDTO() + if include_optional: + return DesignerDataVersionExportsDTO( + data_version_exports = [ + visier_platform_sdk.models.designer/data_version_export_dto.designer.DataVersionExportDTO( + uuid = '', + timestamp = '', + data_version_number = '', + base_data_version_number = '', + tables = [ + visier_platform_sdk.models.designer/data_version_export_table_dto.designer.DataVersionExportTableDTO( + name = '', + common_columns = None, + new_columns = None, + deleted_columns = [ + '' + ], ) + ], + new_tables = [ + '' + ], + deleted_tables = [ + '' + ], ) + ] + ) + else: + return DesignerDataVersionExportsDTO( + ) + """ + + def testDesignerDataVersionExportsDTO(self): + """Test DesignerDataVersionExportsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_databricks_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_databricks_auth_params_dto.py new file mode 100644 index 0000000000..52d519b73d --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_databricks_auth_params_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_databricks_auth_params_dto import DesignerDatabricksAuthParamsDTO + +class TestDesignerDatabricksAuthParamsDTO(unittest.TestCase): + """DesignerDatabricksAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDatabricksAuthParamsDTO: + """Test DesignerDatabricksAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDatabricksAuthParamsDTO` + """ + model = DesignerDatabricksAuthParamsDTO() + if include_optional: + return DesignerDatabricksAuthParamsDTO( + share_credentials_version = '', + bearer_token = '', + endpoint = '', + expiration_time = '' + ) + else: + return DesignerDatabricksAuthParamsDTO( + ) + """ + + def testDesignerDatabricksAuthParamsDTO(self): + """Test DesignerDatabricksAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_dayforce_v2_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_dayforce_v2_auth_params_dto.py new file mode 100644 index 0000000000..9475e9b357 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_dayforce_v2_auth_params_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_dayforce_v2_auth_params_dto import DesignerDayforceV2AuthParamsDTO + +class TestDesignerDayforceV2AuthParamsDTO(unittest.TestCase): + """DesignerDayforceV2AuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDayforceV2AuthParamsDTO: + """Test DesignerDayforceV2AuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDayforceV2AuthParamsDTO` + """ + model = DesignerDayforceV2AuthParamsDTO() + if include_optional: + return DesignerDayforceV2AuthParamsDTO( + username = '', + password = '', + company_id = '', + token_host = '', + host_domain_name = '' + ) + else: + return DesignerDayforceV2AuthParamsDTO( + ) + """ + + def testDesignerDayforceV2AuthParamsDTO(self): + """Test DesignerDayforceV2AuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_dimensions_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_dimensions_auth_params_dto.py new file mode 100644 index 0000000000..ccfb78874b --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_dimensions_auth_params_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_dimensions_auth_params_dto import DesignerDimensionsAuthParamsDTO + +class TestDesignerDimensionsAuthParamsDTO(unittest.TestCase): + """DesignerDimensionsAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDimensionsAuthParamsDTO: + """Test DesignerDimensionsAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDimensionsAuthParamsDTO` + """ + model = DesignerDimensionsAuthParamsDTO() + if include_optional: + return DesignerDimensionsAuthParamsDTO( + app_key = '', + client_id = '', + client_secret = '', + vanity_url = '', + username = '', + password = '' + ) + else: + return DesignerDimensionsAuthParamsDTO( + ) + """ + + def testDesignerDimensionsAuthParamsDTO(self): + """Test DesignerDimensionsAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_download_source_files_dto.py b/src/visier_platform_sdk/test/test_designer_download_source_files_dto.py new file mode 100644 index 0000000000..de9a7e7640 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_download_source_files_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_download_source_files_dto import DesignerDownloadSourceFilesDTO + +class TestDesignerDownloadSourceFilesDTO(unittest.TestCase): + """DesignerDownloadSourceFilesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDownloadSourceFilesDTO: + """Test DesignerDownloadSourceFilesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDownloadSourceFilesDTO` + """ + model = DesignerDownloadSourceFilesDTO() + if include_optional: + return DesignerDownloadSourceFilesDTO( + download_all = True, + sources = [ + '' + ], + source_ids = [ + '' + ], + min_timestamp = '', + max_timestamp = '', + min_snapshot_timestamp = '', + max_snapshot_timestamp = '', + include_non_active_files = True + ) + else: + return DesignerDownloadSourceFilesDTO( + ) + """ + + def testDesignerDownloadSourceFilesDTO(self): + """Test DesignerDownloadSourceFilesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_download_source_files_response_dto.py b/src/visier_platform_sdk/test/test_designer_download_source_files_response_dto.py new file mode 100644 index 0000000000..06cef3a25c --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_download_source_files_response_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_download_source_files_response_dto import DesignerDownloadSourceFilesResponseDTO + +class TestDesignerDownloadSourceFilesResponseDTO(unittest.TestCase): + """DesignerDownloadSourceFilesResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerDownloadSourceFilesResponseDTO: + """Test DesignerDownloadSourceFilesResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerDownloadSourceFilesResponseDTO` + """ + model = DesignerDownloadSourceFilesResponseDTO() + if include_optional: + return DesignerDownloadSourceFilesResponseDTO( + status = '', + messages = '' + ) + else: + return DesignerDownloadSourceFilesResponseDTO( + ) + """ + + def testDesignerDownloadSourceFilesResponseDTO(self): + """Test DesignerDownloadSourceFilesResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_extractor_credential_apidto.py b/src/visier_platform_sdk/test/test_designer_extractor_credential_apidto.py new file mode 100644 index 0000000000..7eaa891b87 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_extractor_credential_apidto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_extractor_credential_apidto import DesignerExtractorCredentialAPIDTO + +class TestDesignerExtractorCredentialAPIDTO(unittest.TestCase): + """DesignerExtractorCredentialAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerExtractorCredentialAPIDTO: + """Test DesignerExtractorCredentialAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerExtractorCredentialAPIDTO` + """ + model = DesignerExtractorCredentialAPIDTO() + if include_optional: + return DesignerExtractorCredentialAPIDTO( + credential_id = '', + display_name = '', + data_provider = '', + is_inherited = True, + auth_context = '' + ) + else: + return DesignerExtractorCredentialAPIDTO( + ) + """ + + def testDesignerExtractorCredentialAPIDTO(self): + """Test DesignerExtractorCredentialAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_extractor_credentials_apidto.py b/src/visier_platform_sdk/test/test_designer_extractor_credentials_apidto.py new file mode 100644 index 0000000000..ba6f8f550d --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_extractor_credentials_apidto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_extractor_credentials_apidto import DesignerExtractorCredentialsAPIDTO + +class TestDesignerExtractorCredentialsAPIDTO(unittest.TestCase): + """DesignerExtractorCredentialsAPIDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerExtractorCredentialsAPIDTO: + """Test DesignerExtractorCredentialsAPIDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerExtractorCredentialsAPIDTO` + """ + model = DesignerExtractorCredentialsAPIDTO() + if include_optional: + return DesignerExtractorCredentialsAPIDTO( + connector_credentials = [ + visier_platform_sdk.models.designer/extractor_credential_apidto.designer.ExtractorCredentialAPIDTO( + credential_id = '', + display_name = '', + data_provider = '', + is_inherited = True, + auth_context = '', ) + ], + limit = 56, + start = 56 + ) + else: + return DesignerExtractorCredentialsAPIDTO( + ) + """ + + def testDesignerExtractorCredentialsAPIDTO(self): + """Test DesignerExtractorCredentialsAPIDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_fusion_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_fusion_auth_params_dto.py new file mode 100644 index 0000000000..32c5c0c41c --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_fusion_auth_params_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_fusion_auth_params_dto import DesignerFusionAuthParamsDTO + +class TestDesignerFusionAuthParamsDTO(unittest.TestCase): + """DesignerFusionAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerFusionAuthParamsDTO: + """Test DesignerFusionAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerFusionAuthParamsDTO` + """ + model = DesignerFusionAuthParamsDTO() + if include_optional: + return DesignerFusionAuthParamsDTO( + username = '', + password = '', + host_domain_name = '' + ) + else: + return DesignerFusionAuthParamsDTO( + ) + """ + + def testDesignerFusionAuthParamsDTO(self): + """Test DesignerFusionAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_gong_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_gong_auth_params_dto.py new file mode 100644 index 0000000000..96653e475c --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_gong_auth_params_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_gong_auth_params_dto import DesignerGongAuthParamsDTO + +class TestDesignerGongAuthParamsDTO(unittest.TestCase): + """DesignerGongAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerGongAuthParamsDTO: + """Test DesignerGongAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerGongAuthParamsDTO` + """ + model = DesignerGongAuthParamsDTO() + if include_optional: + return DesignerGongAuthParamsDTO( + client_id = '', + client_secret = '' + ) + else: + return DesignerGongAuthParamsDTO( + ) + """ + + def testDesignerGongAuthParamsDTO(self): + """Test DesignerGongAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_google_sheets_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_google_sheets_auth_params_dto.py new file mode 100644 index 0000000000..a33f8cca1b --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_google_sheets_auth_params_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_google_sheets_auth_params_dto import DesignerGoogleSheetsAuthParamsDTO + +class TestDesignerGoogleSheetsAuthParamsDTO(unittest.TestCase): + """DesignerGoogleSheetsAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerGoogleSheetsAuthParamsDTO: + """Test DesignerGoogleSheetsAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerGoogleSheetsAuthParamsDTO` + """ + model = DesignerGoogleSheetsAuthParamsDTO() + if include_optional: + return DesignerGoogleSheetsAuthParamsDTO( + auth_code = '', + configuration = '', + client_id = '', + client_secret = '' + ) + else: + return DesignerGoogleSheetsAuthParamsDTO( + ) + """ + + def testDesignerGoogleSheetsAuthParamsDTO(self): + """Test DesignerGoogleSheetsAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_google_workspace_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_google_workspace_auth_params_dto.py new file mode 100644 index 0000000000..356362a377 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_google_workspace_auth_params_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_google_workspace_auth_params_dto import DesignerGoogleWorkspaceAuthParamsDTO + +class TestDesignerGoogleWorkspaceAuthParamsDTO(unittest.TestCase): + """DesignerGoogleWorkspaceAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerGoogleWorkspaceAuthParamsDTO: + """Test DesignerGoogleWorkspaceAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerGoogleWorkspaceAuthParamsDTO` + """ + model = DesignerGoogleWorkspaceAuthParamsDTO() + if include_optional: + return DesignerGoogleWorkspaceAuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '', + service_account = '', + privacy_mode = '' + ) + else: + return DesignerGoogleWorkspaceAuthParamsDTO( + ) + """ + + def testDesignerGoogleWorkspaceAuthParamsDTO(self): + """Test DesignerGoogleWorkspaceAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_greenhouse_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_greenhouse_auth_params_dto.py new file mode 100644 index 0000000000..2294907c24 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_greenhouse_auth_params_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_greenhouse_auth_params_dto import DesignerGreenhouseAuthParamsDTO + +class TestDesignerGreenhouseAuthParamsDTO(unittest.TestCase): + """DesignerGreenhouseAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerGreenhouseAuthParamsDTO: + """Test DesignerGreenhouseAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerGreenhouseAuthParamsDTO` + """ + model = DesignerGreenhouseAuthParamsDTO() + if include_optional: + return DesignerGreenhouseAuthParamsDTO( + api_key = '' + ) + else: + return DesignerGreenhouseAuthParamsDTO( + ) + """ + + def testDesignerGreenhouseAuthParamsDTO(self): + """Test DesignerGreenhouseAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_icims_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_icims_auth_params_dto.py new file mode 100644 index 0000000000..6677b88e11 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_icims_auth_params_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_icims_auth_params_dto import DesignerIcimsAuthParamsDTO + +class TestDesignerIcimsAuthParamsDTO(unittest.TestCase): + """DesignerIcimsAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerIcimsAuthParamsDTO: + """Test DesignerIcimsAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerIcimsAuthParamsDTO` + """ + model = DesignerIcimsAuthParamsDTO() + if include_optional: + return DesignerIcimsAuthParamsDTO( + customer_id = '', + username = '', + password = '', + client_id = '', + client_secret = '', + region = 'US' + ) + else: + return DesignerIcimsAuthParamsDTO( + ) + """ + + def testDesignerIcimsAuthParamsDTO(self): + """Test DesignerIcimsAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_internal_s3_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_internal_s3_auth_params_dto.py new file mode 100644 index 0000000000..ca79582d6c --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_internal_s3_auth_params_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_internal_s3_auth_params_dto import DesignerInternalS3AuthParamsDTO + +class TestDesignerInternalS3AuthParamsDTO(unittest.TestCase): + """DesignerInternalS3AuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerInternalS3AuthParamsDTO: + """Test DesignerInternalS3AuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerInternalS3AuthParamsDTO` + """ + model = DesignerInternalS3AuthParamsDTO() + if include_optional: + return DesignerInternalS3AuthParamsDTO( + bucket_name = '', + path = '' + ) + else: + return DesignerInternalS3AuthParamsDTO( + ) + """ + + def testDesignerInternalS3AuthParamsDTO(self): + """Test DesignerInternalS3AuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_jdbc_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_jdbc_auth_params_dto.py new file mode 100644 index 0000000000..05f3a24759 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_jdbc_auth_params_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_jdbc_auth_params_dto import DesignerJdbcAuthParamsDTO + +class TestDesignerJdbcAuthParamsDTO(unittest.TestCase): + """DesignerJdbcAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerJdbcAuthParamsDTO: + """Test DesignerJdbcAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerJdbcAuthParamsDTO` + """ + model = DesignerJdbcAuthParamsDTO() + if include_optional: + return DesignerJdbcAuthParamsDTO( + jdbc_connect_string = '', + username = '', + password = '' + ) + else: + return DesignerJdbcAuthParamsDTO( + ) + """ + + def testDesignerJdbcAuthParamsDTO(self): + """Test DesignerJdbcAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_jira_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_jira_auth_params_dto.py new file mode 100644 index 0000000000..89738a7b9e --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_jira_auth_params_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_jira_auth_params_dto import DesignerJiraAuthParamsDTO + +class TestDesignerJiraAuthParamsDTO(unittest.TestCase): + """DesignerJiraAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerJiraAuthParamsDTO: + """Test DesignerJiraAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerJiraAuthParamsDTO` + """ + model = DesignerJiraAuthParamsDTO() + if include_optional: + return DesignerJiraAuthParamsDTO( + api_token = '', + host_name = '', + connect_params = visier_platform_sdk.models.designer/jira_connect_params_dto.designer.JiraConnectParamsDTO( + app_key = '', + client_key = '', + shared_secret = '', ) + ) + else: + return DesignerJiraAuthParamsDTO( + ) + """ + + def testDesignerJiraAuthParamsDTO(self): + """Test DesignerJiraAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_jira_connect_params_dto.py b/src/visier_platform_sdk/test/test_designer_jira_connect_params_dto.py new file mode 100644 index 0000000000..327c73337f --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_jira_connect_params_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_jira_connect_params_dto import DesignerJiraConnectParamsDTO + +class TestDesignerJiraConnectParamsDTO(unittest.TestCase): + """DesignerJiraConnectParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerJiraConnectParamsDTO: + """Test DesignerJiraConnectParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerJiraConnectParamsDTO` + """ + model = DesignerJiraConnectParamsDTO() + if include_optional: + return DesignerJiraConnectParamsDTO( + app_key = '', + client_key = '', + shared_secret = '' + ) + else: + return DesignerJiraConnectParamsDTO( + ) + """ + + def testDesignerJiraConnectParamsDTO(self): + """Test DesignerJiraConnectParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_lever_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_lever_auth_params_dto.py new file mode 100644 index 0000000000..9aa6b57de1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_lever_auth_params_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_lever_auth_params_dto import DesignerLeverAuthParamsDTO + +class TestDesignerLeverAuthParamsDTO(unittest.TestCase): + """DesignerLeverAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerLeverAuthParamsDTO: + """Test DesignerLeverAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerLeverAuthParamsDTO` + """ + model = DesignerLeverAuthParamsDTO() + if include_optional: + return DesignerLeverAuthParamsDTO( + api_key = '' + ) + else: + return DesignerLeverAuthParamsDTO( + ) + """ + + def testDesignerLeverAuthParamsDTO(self): + """Test DesignerLeverAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_medallia_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_medallia_auth_params_dto.py new file mode 100644 index 0000000000..ebd54f1dee --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_medallia_auth_params_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_medallia_auth_params_dto import DesignerMedalliaAuthParamsDTO + +class TestDesignerMedalliaAuthParamsDTO(unittest.TestCase): + """DesignerMedalliaAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerMedalliaAuthParamsDTO: + """Test DesignerMedalliaAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerMedalliaAuthParamsDTO` + """ + model = DesignerMedalliaAuthParamsDTO() + if include_optional: + return DesignerMedalliaAuthParamsDTO( + tenant_domain_name = '', + instance_url = '', + client_id = '', + client_secret = '' + ) + else: + return DesignerMedalliaAuthParamsDTO( + ) + """ + + def testDesignerMedalliaAuthParamsDTO(self): + """Test DesignerMedalliaAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_microsoft365_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_microsoft365_auth_params_dto.py new file mode 100644 index 0000000000..86bdb74667 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_microsoft365_auth_params_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_microsoft365_auth_params_dto import DesignerMicrosoft365AuthParamsDTO + +class TestDesignerMicrosoft365AuthParamsDTO(unittest.TestCase): + """DesignerMicrosoft365AuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerMicrosoft365AuthParamsDTO: + """Test DesignerMicrosoft365AuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerMicrosoft365AuthParamsDTO` + """ + model = DesignerMicrosoft365AuthParamsDTO() + if include_optional: + return DesignerMicrosoft365AuthParamsDTO( + o_auth_tenant_id = '', + client_id = '', + client_secret = '', + privacy_mode = '' + ) + else: + return DesignerMicrosoft365AuthParamsDTO( + ) + """ + + def testDesignerMicrosoft365AuthParamsDTO(self): + """Test DesignerMicrosoft365AuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_module_settings_dto.py b/src/visier_platform_sdk/test/test_designer_module_settings_dto.py new file mode 100644 index 0000000000..2755aed3ca --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_module_settings_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_module_settings_dto import DesignerModuleSettingsDTO + +class TestDesignerModuleSettingsDTO(unittest.TestCase): + """DesignerModuleSettingsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerModuleSettingsDTO: + """Test DesignerModuleSettingsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerModuleSettingsDTO` + """ + model = DesignerModuleSettingsDTO() + if include_optional: + return DesignerModuleSettingsDTO( + unavailable_for_assignment = True, + special_handling_instruction = '', + locale = '' + ) + else: + return DesignerModuleSettingsDTO( + ) + """ + + def testDesignerModuleSettingsDTO(self): + """Test DesignerModuleSettingsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_my_sql_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_my_sql_auth_params_dto.py new file mode 100644 index 0000000000..17df42058a --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_my_sql_auth_params_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_my_sql_auth_params_dto import DesignerMySqlAuthParamsDTO + +class TestDesignerMySqlAuthParamsDTO(unittest.TestCase): + """DesignerMySqlAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerMySqlAuthParamsDTO: + """Test DesignerMySqlAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerMySqlAuthParamsDTO` + """ + model = DesignerMySqlAuthParamsDTO() + if include_optional: + return DesignerMySqlAuthParamsDTO( + host = '', + port = '', + username = '', + password = '', + database = '', + ssl_mode = '' + ) + else: + return DesignerMySqlAuthParamsDTO( + ) + """ + + def testDesignerMySqlAuthParamsDTO(self): + """Test DesignerMySqlAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_namely_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_namely_auth_params_dto.py new file mode 100644 index 0000000000..a36e9078c0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_namely_auth_params_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_namely_auth_params_dto import DesignerNamelyAuthParamsDTO + +class TestDesignerNamelyAuthParamsDTO(unittest.TestCase): + """DesignerNamelyAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerNamelyAuthParamsDTO: + """Test DesignerNamelyAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerNamelyAuthParamsDTO` + """ + model = DesignerNamelyAuthParamsDTO() + if include_optional: + return DesignerNamelyAuthParamsDTO( + auth_code = '' + ) + else: + return DesignerNamelyAuthParamsDTO( + ) + """ + + def testDesignerNamelyAuthParamsDTO(self): + """Test DesignerNamelyAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_oracle_db_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_oracle_db_auth_params_dto.py new file mode 100644 index 0000000000..f5e4bd46d2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_oracle_db_auth_params_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_oracle_db_auth_params_dto import DesignerOracleDbAuthParamsDTO + +class TestDesignerOracleDbAuthParamsDTO(unittest.TestCase): + """DesignerOracleDbAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerOracleDbAuthParamsDTO: + """Test DesignerOracleDbAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerOracleDbAuthParamsDTO` + """ + model = DesignerOracleDbAuthParamsDTO() + if include_optional: + return DesignerOracleDbAuthParamsDTO( + host = '', + port = '', + username = '', + password = '', + service_name = '' + ) + else: + return DesignerOracleDbAuthParamsDTO( + ) + """ + + def testDesignerOracleDbAuthParamsDTO(self): + """Test DesignerOracleDbAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_push_data_column_definition_dto.py b/src/visier_platform_sdk/test/test_designer_push_data_column_definition_dto.py new file mode 100644 index 0000000000..d4c3f2287e --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_push_data_column_definition_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_push_data_column_definition_dto import DesignerPushDataColumnDefinitionDTO + +class TestDesignerPushDataColumnDefinitionDTO(unittest.TestCase): + """DesignerPushDataColumnDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerPushDataColumnDefinitionDTO: + """Test DesignerPushDataColumnDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerPushDataColumnDefinitionDTO` + """ + model = DesignerPushDataColumnDefinitionDTO() + if include_optional: + return DesignerPushDataColumnDefinitionDTO( + column_name = '', + data_type = '', + data_formats = [ + '' + ], + is_mandatory = True, + allow_empty = True, + default_value = '' + ) + else: + return DesignerPushDataColumnDefinitionDTO( + ) + """ + + def testDesignerPushDataColumnDefinitionDTO(self): + """Test DesignerPushDataColumnDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_push_data_source_definition_dto.py b/src/visier_platform_sdk/test/test_designer_push_data_source_definition_dto.py new file mode 100644 index 0000000000..56c8afdb52 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_push_data_source_definition_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_push_data_source_definition_dto import DesignerPushDataSourceDefinitionDTO + +class TestDesignerPushDataSourceDefinitionDTO(unittest.TestCase): + """DesignerPushDataSourceDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerPushDataSourceDefinitionDTO: + """Test DesignerPushDataSourceDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerPushDataSourceDefinitionDTO` + """ + model = DesignerPushDataSourceDefinitionDTO() + if include_optional: + return DesignerPushDataSourceDefinitionDTO( + source_id = '', + name = '', + columns = [ + visier_platform_sdk.models.designer/push_data_column_definition_dto.designer.PushDataColumnDefinitionDTO( + column_name = '', + data_type = '', + data_formats = [ + '' + ], + is_mandatory = True, + allow_empty = True, + default_value = '', ) + ], + is_inherited = True + ) + else: + return DesignerPushDataSourceDefinitionDTO( + ) + """ + + def testDesignerPushDataSourceDefinitionDTO(self): + """Test DesignerPushDataSourceDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_push_data_source_definitions_dto.py b/src/visier_platform_sdk/test/test_designer_push_data_source_definitions_dto.py new file mode 100644 index 0000000000..426c652502 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_push_data_source_definitions_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_push_data_source_definitions_dto import DesignerPushDataSourceDefinitionsDTO + +class TestDesignerPushDataSourceDefinitionsDTO(unittest.TestCase): + """DesignerPushDataSourceDefinitionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerPushDataSourceDefinitionsDTO: + """Test DesignerPushDataSourceDefinitionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerPushDataSourceDefinitionsDTO` + """ + model = DesignerPushDataSourceDefinitionsDTO() + if include_optional: + return DesignerPushDataSourceDefinitionsDTO( + sources = [ + visier_platform_sdk.models.designer/push_data_source_definition_dto.designer.PushDataSourceDefinitionDTO( + source_id = '', + name = '', + columns = [ + visier_platform_sdk.models.designer/push_data_column_definition_dto.designer.PushDataColumnDefinitionDTO( + column_name = '', + data_type = '', + data_formats = [ + '' + ], + is_mandatory = True, + allow_empty = True, + default_value = '', ) + ], + is_inherited = True, ) + ] + ) + else: + return DesignerPushDataSourceDefinitionsDTO( + ) + """ + + def testDesignerPushDataSourceDefinitionsDTO(self): + """Test DesignerPushDataSourceDefinitionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_qualtrics_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_qualtrics_auth_params_dto.py new file mode 100644 index 0000000000..ba8bbaab1b --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_qualtrics_auth_params_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_qualtrics_auth_params_dto import DesignerQualtricsAuthParamsDTO + +class TestDesignerQualtricsAuthParamsDTO(unittest.TestCase): + """DesignerQualtricsAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerQualtricsAuthParamsDTO: + """Test DesignerQualtricsAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerQualtricsAuthParamsDTO` + """ + model = DesignerQualtricsAuthParamsDTO() + if include_optional: + return DesignerQualtricsAuthParamsDTO( + api_token = '', + data_center_id = '' + ) + else: + return DesignerQualtricsAuthParamsDTO( + ) + """ + + def testDesignerQualtricsAuthParamsDTO(self): + """Test DesignerQualtricsAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_redshift_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_redshift_auth_params_dto.py new file mode 100644 index 0000000000..d8d334449a --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_redshift_auth_params_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_redshift_auth_params_dto import DesignerRedshiftAuthParamsDTO + +class TestDesignerRedshiftAuthParamsDTO(unittest.TestCase): + """DesignerRedshiftAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerRedshiftAuthParamsDTO: + """Test DesignerRedshiftAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerRedshiftAuthParamsDTO` + """ + model = DesignerRedshiftAuthParamsDTO() + if include_optional: + return DesignerRedshiftAuthParamsDTO( + endpoint = '', + port = '', + database = '', + username = '', + password = '', + table_prefix = '', + var_schema = '' + ) + else: + return DesignerRedshiftAuthParamsDTO( + ) + """ + + def testDesignerRedshiftAuthParamsDTO(self): + """Test DesignerRedshiftAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_salesforce_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_salesforce_auth_params_dto.py new file mode 100644 index 0000000000..3491a6a500 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_salesforce_auth_params_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_salesforce_auth_params_dto import DesignerSalesforceAuthParamsDTO + +class TestDesignerSalesforceAuthParamsDTO(unittest.TestCase): + """DesignerSalesforceAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerSalesforceAuthParamsDTO: + """Test DesignerSalesforceAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerSalesforceAuthParamsDTO` + """ + model = DesignerSalesforceAuthParamsDTO() + if include_optional: + return DesignerSalesforceAuthParamsDTO( + refresh_token = '', + client_id = '' + ) + else: + return DesignerSalesforceAuthParamsDTO( + ) + """ + + def testDesignerSalesforceAuthParamsDTO(self): + """Test DesignerSalesforceAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_salesforce_v2_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_salesforce_v2_auth_params_dto.py new file mode 100644 index 0000000000..fa959810fa --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_salesforce_v2_auth_params_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_salesforce_v2_auth_params_dto import DesignerSalesforceV2AuthParamsDTO + +class TestDesignerSalesforceV2AuthParamsDTO(unittest.TestCase): + """DesignerSalesforceV2AuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerSalesforceV2AuthParamsDTO: + """Test DesignerSalesforceV2AuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerSalesforceV2AuthParamsDTO` + """ + model = DesignerSalesforceV2AuthParamsDTO() + if include_optional: + return DesignerSalesforceV2AuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '', + login_host = '' + ) + else: + return DesignerSalesforceV2AuthParamsDTO( + ) + """ + + def testDesignerSalesforceV2AuthParamsDTO(self): + """Test DesignerSalesforceV2AuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_service_now_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_service_now_auth_params_dto.py new file mode 100644 index 0000000000..220de2d350 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_service_now_auth_params_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_service_now_auth_params_dto import DesignerServiceNowAuthParamsDTO + +class TestDesignerServiceNowAuthParamsDTO(unittest.TestCase): + """DesignerServiceNowAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerServiceNowAuthParamsDTO: + """Test DesignerServiceNowAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerServiceNowAuthParamsDTO` + """ + model = DesignerServiceNowAuthParamsDTO() + if include_optional: + return DesignerServiceNowAuthParamsDTO( + host_domain_name = '', + username = '', + password = '' + ) + else: + return DesignerServiceNowAuthParamsDTO( + ) + """ + + def testDesignerServiceNowAuthParamsDTO(self): + """Test DesignerServiceNowAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_service_now_v2_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_service_now_v2_auth_params_dto.py new file mode 100644 index 0000000000..77697302e2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_service_now_v2_auth_params_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_service_now_v2_auth_params_dto import DesignerServiceNowV2AuthParamsDTO + +class TestDesignerServiceNowV2AuthParamsDTO(unittest.TestCase): + """DesignerServiceNowV2AuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerServiceNowV2AuthParamsDTO: + """Test DesignerServiceNowV2AuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerServiceNowV2AuthParamsDTO` + """ + model = DesignerServiceNowV2AuthParamsDTO() + if include_optional: + return DesignerServiceNowV2AuthParamsDTO( + host_domain_name = '', + client_id = '', + client_secret = '', + auth_code = '', + alternate_domain = '' + ) + else: + return DesignerServiceNowV2AuthParamsDTO( + ) + """ + + def testDesignerServiceNowV2AuthParamsDTO(self): + """Test DesignerServiceNowV2AuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_slack_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_slack_auth_params_dto.py new file mode 100644 index 0000000000..37e472994e --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_slack_auth_params_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_slack_auth_params_dto import DesignerSlackAuthParamsDTO + +class TestDesignerSlackAuthParamsDTO(unittest.TestCase): + """DesignerSlackAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerSlackAuthParamsDTO: + """Test DesignerSlackAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerSlackAuthParamsDTO` + """ + model = DesignerSlackAuthParamsDTO() + if include_optional: + return DesignerSlackAuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '' + ) + else: + return DesignerSlackAuthParamsDTO( + ) + """ + + def testDesignerSlackAuthParamsDTO(self): + """Test DesignerSlackAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_snowflake_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_snowflake_auth_params_dto.py new file mode 100644 index 0000000000..e85dd17f4e --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_snowflake_auth_params_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_snowflake_auth_params_dto import DesignerSnowflakeAuthParamsDTO + +class TestDesignerSnowflakeAuthParamsDTO(unittest.TestCase): + """DesignerSnowflakeAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerSnowflakeAuthParamsDTO: + """Test DesignerSnowflakeAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerSnowflakeAuthParamsDTO` + """ + model = DesignerSnowflakeAuthParamsDTO() + if include_optional: + return DesignerSnowflakeAuthParamsDTO( + account_identifier = '', + database = '', + var_schema = '', + username = '', + password = '', + warehouse = '', + private_key = '' + ) + else: + return DesignerSnowflakeAuthParamsDTO( + ) + """ + + def testDesignerSnowflakeAuthParamsDTO(self): + """Test DesignerSnowflakeAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_sql_server_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_sql_server_auth_params_dto.py new file mode 100644 index 0000000000..d0bbdd7a7c --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_sql_server_auth_params_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_sql_server_auth_params_dto import DesignerSqlServerAuthParamsDTO + +class TestDesignerSqlServerAuthParamsDTO(unittest.TestCase): + """DesignerSqlServerAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerSqlServerAuthParamsDTO: + """Test DesignerSqlServerAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerSqlServerAuthParamsDTO` + """ + model = DesignerSqlServerAuthParamsDTO() + if include_optional: + return DesignerSqlServerAuthParamsDTO( + host = '', + port = '', + username = '', + password = '', + database = '' + ) + else: + return DesignerSqlServerAuthParamsDTO( + ) + """ + + def testDesignerSqlServerAuthParamsDTO(self): + """Test DesignerSqlServerAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_subject_missing_access_dto.py b/src/visier_platform_sdk/test/test_designer_subject_missing_access_dto.py new file mode 100644 index 0000000000..de871d78fd --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_subject_missing_access_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_subject_missing_access_dto import DesignerSubjectMissingAccessDTO + +class TestDesignerSubjectMissingAccessDTO(unittest.TestCase): + """DesignerSubjectMissingAccessDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerSubjectMissingAccessDTO: + """Test DesignerSubjectMissingAccessDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerSubjectMissingAccessDTO` + """ + model = DesignerSubjectMissingAccessDTO() + if include_optional: + return DesignerSubjectMissingAccessDTO( + subject = 'Employee', + attributes = [ + '' + ], + error_message = '' + ) + else: + return DesignerSubjectMissingAccessDTO( + ) + """ + + def testDesignerSubjectMissingAccessDTO(self): + """Test DesignerSubjectMissingAccessDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_success_factors_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_success_factors_auth_params_dto.py new file mode 100644 index 0000000000..4e1439b37a --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_success_factors_auth_params_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_success_factors_auth_params_dto import DesignerSuccessFactorsAuthParamsDTO + +class TestDesignerSuccessFactorsAuthParamsDTO(unittest.TestCase): + """DesignerSuccessFactorsAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerSuccessFactorsAuthParamsDTO: + """Test DesignerSuccessFactorsAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerSuccessFactorsAuthParamsDTO` + """ + model = DesignerSuccessFactorsAuthParamsDTO() + if include_optional: + return DesignerSuccessFactorsAuthParamsDTO( + host_domain_name = '', + company_id = '', + username = '', + password = '', + o_auth = visier_platform_sdk.models.designer/success_factors_o_auth_params_dto.designer.SuccessFactorsOAuthParamsDTO( + api_key = '', + private_x509_key = '', + public_x509_cert = '', ) + ) + else: + return DesignerSuccessFactorsAuthParamsDTO( + ) + """ + + def testDesignerSuccessFactorsAuthParamsDTO(self): + """Test DesignerSuccessFactorsAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_success_factors_o_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_success_factors_o_auth_params_dto.py new file mode 100644 index 0000000000..5e46187d73 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_success_factors_o_auth_params_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_success_factors_o_auth_params_dto import DesignerSuccessFactorsOAuthParamsDTO + +class TestDesignerSuccessFactorsOAuthParamsDTO(unittest.TestCase): + """DesignerSuccessFactorsOAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerSuccessFactorsOAuthParamsDTO: + """Test DesignerSuccessFactorsOAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerSuccessFactorsOAuthParamsDTO` + """ + model = DesignerSuccessFactorsOAuthParamsDTO() + if include_optional: + return DesignerSuccessFactorsOAuthParamsDTO( + api_key = '', + private_x509_key = '', + public_x509_cert = '' + ) + else: + return DesignerSuccessFactorsOAuthParamsDTO( + ) + """ + + def testDesignerSuccessFactorsOAuthParamsDTO(self): + """Test DesignerSuccessFactorsOAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_tenant_module_dto.py b/src/visier_platform_sdk/test/test_designer_tenant_module_dto.py new file mode 100644 index 0000000000..c5963e0866 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_tenant_module_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_tenant_module_dto import DesignerTenantModuleDTO + +class TestDesignerTenantModuleDTO(unittest.TestCase): + """DesignerTenantModuleDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerTenantModuleDTO: + """Test DesignerTenantModuleDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerTenantModuleDTO` + """ + model = DesignerTenantModuleDTO() + if include_optional: + return DesignerTenantModuleDTO( + display_name = '', + symbol_name = '', + module_settings = visier_platform_sdk.models.designer/module_settings_dto.designer.ModuleSettingsDTO( + unavailable_for_assignment = True, + special_handling_instruction = '', + locale = '', ) + ) + else: + return DesignerTenantModuleDTO( + ) + """ + + def testDesignerTenantModuleDTO(self): + """Test DesignerTenantModuleDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_ultimate_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_ultimate_auth_params_dto.py new file mode 100644 index 0000000000..cc16a1e0c6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_ultimate_auth_params_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_ultimate_auth_params_dto import DesignerUltimateAuthParamsDTO + +class TestDesignerUltimateAuthParamsDTO(unittest.TestCase): + """DesignerUltimateAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerUltimateAuthParamsDTO: + """Test DesignerUltimateAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerUltimateAuthParamsDTO` + """ + model = DesignerUltimateAuthParamsDTO() + if include_optional: + return DesignerUltimateAuthParamsDTO( + host_domain_name = '', + api_key = '', + username = '', + password = '', + user_access_key = '' + ) + else: + return DesignerUltimateAuthParamsDTO( + ) + """ + + def testDesignerUltimateAuthParamsDTO(self): + """Test DesignerUltimateAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_webhook_webhook_basic_auth_credential_dto.py b/src/visier_platform_sdk/test/test_designer_webhook_webhook_basic_auth_credential_dto.py new file mode 100644 index 0000000000..f3791be69e --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_webhook_webhook_basic_auth_credential_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_webhook_webhook_basic_auth_credential_dto import DesignerWebhookWebhookBasicAuthCredentialDTO + +class TestDesignerWebhookWebhookBasicAuthCredentialDTO(unittest.TestCase): + """DesignerWebhookWebhookBasicAuthCredentialDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWebhookWebhookBasicAuthCredentialDTO: + """Test DesignerWebhookWebhookBasicAuthCredentialDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWebhookWebhookBasicAuthCredentialDTO` + """ + model = DesignerWebhookWebhookBasicAuthCredentialDTO() + if include_optional: + return DesignerWebhookWebhookBasicAuthCredentialDTO( + username = '', + password = '' + ) + else: + return DesignerWebhookWebhookBasicAuthCredentialDTO( + ) + """ + + def testDesignerWebhookWebhookBasicAuthCredentialDTO(self): + """Test DesignerWebhookWebhookBasicAuthCredentialDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_webhook_webhook_credentials_dto.py b/src/visier_platform_sdk/test/test_designer_webhook_webhook_credentials_dto.py new file mode 100644 index 0000000000..333e04ff1f --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_webhook_webhook_credentials_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_webhook_webhook_credentials_dto import DesignerWebhookWebhookCredentialsDTO + +class TestDesignerWebhookWebhookCredentialsDTO(unittest.TestCase): + """DesignerWebhookWebhookCredentialsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWebhookWebhookCredentialsDTO: + """Test DesignerWebhookWebhookCredentialsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWebhookWebhookCredentialsDTO` + """ + model = DesignerWebhookWebhookCredentialsDTO() + if include_optional: + return DesignerWebhookWebhookCredentialsDTO( + basic_auth = visier_platform_sdk.models.designer/webhook/webhook_basic_auth_credential_dto.designer.webhook.WebhookBasicAuthCredentialDTO( + username = '', + password = '', ), + access_token = '' + ) + else: + return DesignerWebhookWebhookCredentialsDTO( + ) + """ + + def testDesignerWebhookWebhookCredentialsDTO(self): + """Test DesignerWebhookWebhookCredentialsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_webhook_webhook_details_dto.py b/src/visier_platform_sdk/test/test_designer_webhook_webhook_details_dto.py new file mode 100644 index 0000000000..0ee72f03da --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_webhook_webhook_details_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_webhook_webhook_details_dto import DesignerWebhookWebhookDetailsDTO + +class TestDesignerWebhookWebhookDetailsDTO(unittest.TestCase): + """DesignerWebhookWebhookDetailsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWebhookWebhookDetailsDTO: + """Test DesignerWebhookWebhookDetailsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWebhookWebhookDetailsDTO` + """ + model = DesignerWebhookWebhookDetailsDTO() + if include_optional: + return DesignerWebhookWebhookDetailsDTO( + target_url = '', + is_active = True, + events = [ + visier_platform_sdk.models.designer/webhook/webhook_event_type_dto.designer.webhook.WebhookEventTypeDTO( + event_type = '', ) + ], + key_name = '', + display_name = '' + ) + else: + return DesignerWebhookWebhookDetailsDTO( + ) + """ + + def testDesignerWebhookWebhookDetailsDTO(self): + """Test DesignerWebhookWebhookDetailsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_webhook_webhook_dto.py b/src/visier_platform_sdk/test/test_designer_webhook_webhook_dto.py new file mode 100644 index 0000000000..52c71d1153 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_webhook_webhook_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_webhook_webhook_dto import DesignerWebhookWebhookDTO + +class TestDesignerWebhookWebhookDTO(unittest.TestCase): + """DesignerWebhookWebhookDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWebhookWebhookDTO: + """Test DesignerWebhookWebhookDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWebhookWebhookDTO` + """ + model = DesignerWebhookWebhookDTO() + if include_optional: + return DesignerWebhookWebhookDTO( + webhook_id = '', + details = visier_platform_sdk.models.designer/webhook/webhook_details_dto.designer.webhook.WebhookDetailsDTO( + target_url = '', + is_active = True, + events = [ + visier_platform_sdk.models.designer/webhook/webhook_event_type_dto.designer.webhook.WebhookEventTypeDTO( + event_type = '', ) + ], + key_name = '', + display_name = '', ), + credential_reference = '' + ) + else: + return DesignerWebhookWebhookDTO( + ) + """ + + def testDesignerWebhookWebhookDTO(self): + """Test DesignerWebhookWebhookDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_webhook_webhook_event_type_dto.py b/src/visier_platform_sdk/test/test_designer_webhook_webhook_event_type_dto.py new file mode 100644 index 0000000000..1b4d0a3344 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_webhook_webhook_event_type_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_webhook_webhook_event_type_dto import DesignerWebhookWebhookEventTypeDTO + +class TestDesignerWebhookWebhookEventTypeDTO(unittest.TestCase): + """DesignerWebhookWebhookEventTypeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWebhookWebhookEventTypeDTO: + """Test DesignerWebhookWebhookEventTypeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWebhookWebhookEventTypeDTO` + """ + model = DesignerWebhookWebhookEventTypeDTO() + if include_optional: + return DesignerWebhookWebhookEventTypeDTO( + event_type = '' + ) + else: + return DesignerWebhookWebhookEventTypeDTO( + ) + """ + + def testDesignerWebhookWebhookEventTypeDTO(self): + """Test DesignerWebhookWebhookEventTypeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_webhook_webhook_message_response_dto.py b/src/visier_platform_sdk/test/test_designer_webhook_webhook_message_response_dto.py new file mode 100644 index 0000000000..11eca7247b --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_webhook_webhook_message_response_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_webhook_webhook_message_response_dto import DesignerWebhookWebhookMessageResponseDTO + +class TestDesignerWebhookWebhookMessageResponseDTO(unittest.TestCase): + """DesignerWebhookWebhookMessageResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWebhookWebhookMessageResponseDTO: + """Test DesignerWebhookWebhookMessageResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWebhookWebhookMessageResponseDTO` + """ + model = DesignerWebhookWebhookMessageResponseDTO() + if include_optional: + return DesignerWebhookWebhookMessageResponseDTO( + status_code = 56, + message = '', + message_id = '', + event_id = '' + ) + else: + return DesignerWebhookWebhookMessageResponseDTO( + ) + """ + + def testDesignerWebhookWebhookMessageResponseDTO(self): + """Test DesignerWebhookWebhookMessageResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_webhook_webhook_request_dto.py b/src/visier_platform_sdk/test/test_designer_webhook_webhook_request_dto.py new file mode 100644 index 0000000000..3ec6ee7652 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_webhook_webhook_request_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_webhook_webhook_request_dto import DesignerWebhookWebhookRequestDTO + +class TestDesignerWebhookWebhookRequestDTO(unittest.TestCase): + """DesignerWebhookWebhookRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWebhookWebhookRequestDTO: + """Test DesignerWebhookWebhookRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWebhookWebhookRequestDTO` + """ + model = DesignerWebhookWebhookRequestDTO() + if include_optional: + return DesignerWebhookWebhookRequestDTO( + details = visier_platform_sdk.models.designer/webhook/webhook_details_dto.designer.webhook.WebhookDetailsDTO( + target_url = '', + is_active = True, + events = [ + visier_platform_sdk.models.designer/webhook/webhook_event_type_dto.designer.webhook.WebhookEventTypeDTO( + event_type = '', ) + ], + key_name = '', + display_name = '', ), + credentials = visier_platform_sdk.models.designer/webhook/webhook_credentials_dto.designer.webhook.WebhookCredentialsDTO( + basic_auth = None, + access_token = '', ) + ) + else: + return DesignerWebhookWebhookRequestDTO( + ) + """ + + def testDesignerWebhookWebhookRequestDTO(self): + """Test DesignerWebhookWebhookRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_webhook_webhooks_dto.py b/src/visier_platform_sdk/test/test_designer_webhook_webhooks_dto.py new file mode 100644 index 0000000000..0a0669618c --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_webhook_webhooks_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_webhook_webhooks_dto import DesignerWebhookWebhooksDTO + +class TestDesignerWebhookWebhooksDTO(unittest.TestCase): + """DesignerWebhookWebhooksDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWebhookWebhooksDTO: + """Test DesignerWebhookWebhooksDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWebhookWebhooksDTO` + """ + model = DesignerWebhookWebhooksDTO() + if include_optional: + return DesignerWebhookWebhooksDTO( + webhooks = [ + visier_platform_sdk.models.designer/webhook/webhook_dto.designer.webhook.WebhookDTO( + webhook_id = '', + details = None, + credential_reference = '', ) + ] + ) + else: + return DesignerWebhookWebhooksDTO( + ) + """ + + def testDesignerWebhookWebhooksDTO(self): + """Test DesignerWebhookWebhooksDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_willow_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_willow_auth_params_dto.py new file mode 100644 index 0000000000..501ae0e290 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_willow_auth_params_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_willow_auth_params_dto import DesignerWillowAuthParamsDTO + +class TestDesignerWillowAuthParamsDTO(unittest.TestCase): + """DesignerWillowAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWillowAuthParamsDTO: + """Test DesignerWillowAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWillowAuthParamsDTO` + """ + model = DesignerWillowAuthParamsDTO() + if include_optional: + return DesignerWillowAuthParamsDTO( + api_token = '', + host_name = '' + ) + else: + return DesignerWillowAuthParamsDTO( + ) + """ + + def testDesignerWillowAuthParamsDTO(self): + """Test DesignerWillowAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_workday_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_workday_auth_params_dto.py new file mode 100644 index 0000000000..32fef506d7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_workday_auth_params_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_workday_auth_params_dto import DesignerWorkdayAuthParamsDTO + +class TestDesignerWorkdayAuthParamsDTO(unittest.TestCase): + """DesignerWorkdayAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWorkdayAuthParamsDTO: + """Test DesignerWorkdayAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWorkdayAuthParamsDTO` + """ + model = DesignerWorkdayAuthParamsDTO() + if include_optional: + return DesignerWorkdayAuthParamsDTO( + user_id = '', + domain_name = '', + implementation_name = '', + password = '', + o_auth = visier_platform_sdk.models.designer/workday_o_auth_params_dto.designer.WorkdayOAuthParamsDTO( + api_client_id = '', + public_x509_cert = '', + private_x509_key = '', ), + ref_token = visier_platform_sdk.models.designer/workday_refresh_token_params_dto.designer.WorkdayRefreshTokenParamsDTO( + api_client_id = '', + client_secret = '', + refresh_token = '', ), + integration_system_id = '', + api_key = '' + ) + else: + return DesignerWorkdayAuthParamsDTO( + ) + """ + + def testDesignerWorkdayAuthParamsDTO(self): + """Test DesignerWorkdayAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_workday_o_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_workday_o_auth_params_dto.py new file mode 100644 index 0000000000..537871922b --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_workday_o_auth_params_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_workday_o_auth_params_dto import DesignerWorkdayOAuthParamsDTO + +class TestDesignerWorkdayOAuthParamsDTO(unittest.TestCase): + """DesignerWorkdayOAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWorkdayOAuthParamsDTO: + """Test DesignerWorkdayOAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWorkdayOAuthParamsDTO` + """ + model = DesignerWorkdayOAuthParamsDTO() + if include_optional: + return DesignerWorkdayOAuthParamsDTO( + api_client_id = '', + public_x509_cert = '', + private_x509_key = '' + ) + else: + return DesignerWorkdayOAuthParamsDTO( + ) + """ + + def testDesignerWorkdayOAuthParamsDTO(self): + """Test DesignerWorkdayOAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_workday_raas_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_workday_raas_auth_params_dto.py new file mode 100644 index 0000000000..dce1a6bf26 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_workday_raas_auth_params_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_workday_raas_auth_params_dto import DesignerWorkdayRaasAuthParamsDTO + +class TestDesignerWorkdayRaasAuthParamsDTO(unittest.TestCase): + """DesignerWorkdayRaasAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWorkdayRaasAuthParamsDTO: + """Test DesignerWorkdayRaasAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWorkdayRaasAuthParamsDTO` + """ + model = DesignerWorkdayRaasAuthParamsDTO() + if include_optional: + return DesignerWorkdayRaasAuthParamsDTO( + user_id = '', + domain_name = '', + implementation_name = '', + password = '', + test_report_url = '' + ) + else: + return DesignerWorkdayRaasAuthParamsDTO( + ) + """ + + def testDesignerWorkdayRaasAuthParamsDTO(self): + """Test DesignerWorkdayRaasAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_workday_refresh_token_params_dto.py b/src/visier_platform_sdk/test/test_designer_workday_refresh_token_params_dto.py new file mode 100644 index 0000000000..60c51148c9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_workday_refresh_token_params_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_workday_refresh_token_params_dto import DesignerWorkdayRefreshTokenParamsDTO + +class TestDesignerWorkdayRefreshTokenParamsDTO(unittest.TestCase): + """DesignerWorkdayRefreshTokenParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerWorkdayRefreshTokenParamsDTO: + """Test DesignerWorkdayRefreshTokenParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerWorkdayRefreshTokenParamsDTO` + """ + model = DesignerWorkdayRefreshTokenParamsDTO() + if include_optional: + return DesignerWorkdayRefreshTokenParamsDTO( + api_client_id = '', + client_secret = '', + refresh_token = '' + ) + else: + return DesignerWorkdayRefreshTokenParamsDTO( + ) + """ + + def testDesignerWorkdayRefreshTokenParamsDTO(self): + """Test DesignerWorkdayRefreshTokenParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_designer_zoom_auth_params_dto.py b/src/visier_platform_sdk/test/test_designer_zoom_auth_params_dto.py new file mode 100644 index 0000000000..248e5dad72 --- /dev/null +++ b/src/visier_platform_sdk/test/test_designer_zoom_auth_params_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.designer_zoom_auth_params_dto import DesignerZoomAuthParamsDTO + +class TestDesignerZoomAuthParamsDTO(unittest.TestCase): + """DesignerZoomAuthParamsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DesignerZoomAuthParamsDTO: + """Test DesignerZoomAuthParamsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DesignerZoomAuthParamsDTO` + """ + model = DesignerZoomAuthParamsDTO() + if include_optional: + return DesignerZoomAuthParamsDTO( + auth_code = '', + client_id = '', + client_secret = '' + ) + else: + return DesignerZoomAuthParamsDTO( + ) + """ + + def testDesignerZoomAuthParamsDTO(self): + """Test DesignerZoomAuthParamsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dimension_member.py b/src/visier_platform_sdk/test/test_dimension_member.py new file mode 100644 index 0000000000..81a88c18d1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dimension_member.py @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dimension_member import DimensionMember + +class TestDimensionMember(unittest.TestCase): + """DimensionMember unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DimensionMember: + """Test DimensionMember + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DimensionMember` + """ + model = DimensionMember() + if include_optional: + return DimensionMember( + id = '', + name = '', + description = '', + has_benchmark_value = True, + has_children = True, + status = 'active', + display_id = '', + short_description_sections = [ + visier_platform_sdk.models.description_entry.DescriptionEntry( + label = '', + text = '', ) + ], + job_domain = '', + job_subdomain = '', + typical_titles = [ + '' + ], + related_jobs = [ + '' + ], + naics_id = '', + naics_name = '', + naics_description = '', + soc_code = '', + soc_name = '', + soc_codes = None, + soc_names = None + ) + else: + return DimensionMember( + id = '', + name = '', + description = '', + has_benchmark_value = True, + has_children = True, + status = 'active', + ) + """ + + def testDimensionMember(self): + """Test DimensionMember""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dimensions_api.py b/src/visier_platform_sdk/test/test_dimensions_api.py new file mode 100644 index 0000000000..afbefa7067 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dimensions_api.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.dimensions_api import DimensionsApi + + +class TestDimensionsApi(unittest.TestCase): + """DimensionsApi unit test stubs""" + + def setUp(self) -> None: + self.api = DimensionsApi() + + def tearDown(self) -> None: + pass + + def test_get_career_levels(self) -> None: + """Test case for get_career_levels + + Get career levels + """ + pass + + def test_get_company_sizes(self) -> None: + """Test case for get_company_sizes + + Get company sizes + """ + pass + + def test_get_industries(self) -> None: + """Test case for get_industries + + Get industries + """ + pass + + def test_get_job_hierarchies(self) -> None: + """Test case for get_job_hierarchies + + Get job hierarchies + """ + pass + + def test_get_jobs(self) -> None: + """Test case for get_jobs + + Get jobs + """ + pass + + def test_get_locations(self) -> None: + """Test case for get_locations + + Get locations + """ + pass + + def test_search_jobs(self) -> None: + """Test case for search_jobs + + Search jobs by IDs + """ + pass + + def test_search_locations_in_bulk(self) -> None: + """Test case for search_locations_in_bulk + + Get location members in bulk + """ + pass + + def test_standardize_jobs_in_bulk(self) -> None: + """Test case for standardize_jobs_in_bulk + + Standardize custom job titles in bulk + """ + pass + + def test_submit_jobs_feedback(self) -> None: + """Test case for submit_jobs_feedback + + Send feedback to help improve the quality of the job match results + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_direct_data_intake_api.py b/src/visier_platform_sdk/test/test_direct_data_intake_api.py new file mode 100644 index 0000000000..af982b893d --- /dev/null +++ b/src/visier_platform_sdk/test/test_direct_data_intake_api.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.direct_data_intake_api import DirectDataIntakeApi + + +class TestDirectDataIntakeApi(unittest.TestCase): + """DirectDataIntakeApi unit test stubs""" + + def setUp(self) -> None: + self.api = DirectDataIntakeApi() + + def tearDown(self) -> None: + pass + + def test_commit_transaction(self) -> None: + """Test case for commit_transaction + + Commit a transaction + """ + pass + + def test_get_config(self) -> None: + """Test case for get_config + + Get the direct data intake configuration + """ + pass + + def test_job_status(self) -> None: + """Test case for job_status + + Check transaction status + """ + pass + + def test_list_transactions(self) -> None: + """Test case for list_transactions + + Retrieve a list of open transactions + """ + pass + + def test_load_sample_data(self) -> None: + """Test case for load_sample_data + + Load sample data + """ + pass + + def test_object_schema(self) -> None: + """Test case for object_schema + + Retrieve an object's data load schema + """ + pass + + def test_put_config(self) -> None: + """Test case for put_config + + Update the direct data intake configuration + """ + pass + + def test_rollback_transaction(self) -> None: + """Test case for rollback_transaction + + Roll back a transaction + """ + pass + + def test_start_transaction(self) -> None: + """Test case for start_transaction + + Start a direct data intake transaction + """ + pass + + def test_upload_file(self) -> None: + """Test case for upload_file + + Upload files + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_direct_data_upload_file_response_dto.py b/src/visier_platform_sdk/test/test_direct_data_upload_file_response_dto.py new file mode 100644 index 0000000000..87f4c80e4c --- /dev/null +++ b/src/visier_platform_sdk/test/test_direct_data_upload_file_response_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.direct_data_upload_file_response_dto import DirectDataUploadFileResponseDTO + +class TestDirectDataUploadFileResponseDTO(unittest.TestCase): + """DirectDataUploadFileResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DirectDataUploadFileResponseDTO: + """Test DirectDataUploadFileResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DirectDataUploadFileResponseDTO` + """ + model = DirectDataUploadFileResponseDTO() + if include_optional: + return DirectDataUploadFileResponseDTO( + transaction_id = '', + status = '', + message = '' + ) + else: + return DirectDataUploadFileResponseDTO( + ) + """ + + def testDirectDataUploadFileResponseDTO(self): + """Test DirectDataUploadFileResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dp_automation_metric_validation_summary_dto.py b/src/visier_platform_sdk/test/test_dp_automation_metric_validation_summary_dto.py new file mode 100644 index 0000000000..f5fc067b8a --- /dev/null +++ b/src/visier_platform_sdk/test/test_dp_automation_metric_validation_summary_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dp_automation_metric_validation_summary_dto import DpAutomationMetricValidationSummaryDTO + +class TestDpAutomationMetricValidationSummaryDTO(unittest.TestCase): + """DpAutomationMetricValidationSummaryDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DpAutomationMetricValidationSummaryDTO: + """Test DpAutomationMetricValidationSummaryDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DpAutomationMetricValidationSummaryDTO` + """ + model = DpAutomationMetricValidationSummaryDTO() + if include_optional: + return DpAutomationMetricValidationSummaryDTO( + symbol_name = '', + display_name = '', + value = 1.337 + ) + else: + return DpAutomationMetricValidationSummaryDTO( + ) + """ + + def testDpAutomationMetricValidationSummaryDTO(self): + """Test DpAutomationMetricValidationSummaryDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dp_automation_tenant_preview_entries_summary_dto.py b/src/visier_platform_sdk/test/test_dp_automation_tenant_preview_entries_summary_dto.py new file mode 100644 index 0000000000..8c9ef211af --- /dev/null +++ b/src/visier_platform_sdk/test/test_dp_automation_tenant_preview_entries_summary_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_dto import DpAutomationTenantPreviewEntriesSummaryDTO + +class TestDpAutomationTenantPreviewEntriesSummaryDTO(unittest.TestCase): + """DpAutomationTenantPreviewEntriesSummaryDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DpAutomationTenantPreviewEntriesSummaryDTO: + """Test DpAutomationTenantPreviewEntriesSummaryDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DpAutomationTenantPreviewEntriesSummaryDTO` + """ + model = DpAutomationTenantPreviewEntriesSummaryDTO() + if include_optional: + return DpAutomationTenantPreviewEntriesSummaryDTO( + tenant_code = '', + data_version = '', + data_version_date = '', + metrics = [ + visier_platform_sdk.models.dp_automation/metric_validation_summary_dto.dp_automation.MetricValidationSummaryDTO( + symbol_name = '', + display_name = '', + value = 1.337, ) + ] + ) + else: + return DpAutomationTenantPreviewEntriesSummaryDTO( + ) + """ + + def testDpAutomationTenantPreviewEntriesSummaryDTO(self): + """Test DpAutomationTenantPreviewEntriesSummaryDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dp_automation_tenant_preview_entries_summary_list_dto.py b/src/visier_platform_sdk/test/test_dp_automation_tenant_preview_entries_summary_list_dto.py new file mode 100644 index 0000000000..13df1aafc4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dp_automation_tenant_preview_entries_summary_list_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_list_dto import DpAutomationTenantPreviewEntriesSummaryListDTO + +class TestDpAutomationTenantPreviewEntriesSummaryListDTO(unittest.TestCase): + """DpAutomationTenantPreviewEntriesSummaryListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DpAutomationTenantPreviewEntriesSummaryListDTO: + """Test DpAutomationTenantPreviewEntriesSummaryListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DpAutomationTenantPreviewEntriesSummaryListDTO` + """ + model = DpAutomationTenantPreviewEntriesSummaryListDTO() + if include_optional: + return DpAutomationTenantPreviewEntriesSummaryListDTO( + tenants = [ + visier_platform_sdk.models.dp_automation/tenant_preview_entries_summary_dto.dp_automation.TenantPreviewEntriesSummaryDTO( + tenant_code = '', + data_version = '', + data_version_date = '', + metrics = [ + visier_platform_sdk.models.dp_automation/metric_validation_summary_dto.dp_automation.MetricValidationSummaryDTO( + symbol_name = '', + display_name = '', + value = 1.337, ) + ], ) + ], + limit = 56, + start = 56 + ) + else: + return DpAutomationTenantPreviewEntriesSummaryListDTO( + ) + """ + + def testDpAutomationTenantPreviewEntriesSummaryListDTO(self): + """Test DpAutomationTenantPreviewEntriesSummaryListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dp_cancel_job_batch_from_job_id_dto.py b/src/visier_platform_sdk/test/test_dp_cancel_job_batch_from_job_id_dto.py new file mode 100644 index 0000000000..967098ad1d --- /dev/null +++ b/src/visier_platform_sdk/test/test_dp_cancel_job_batch_from_job_id_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dp_cancel_job_batch_from_job_id_dto import DpCancelJobBatchFromJobIdDTO + +class TestDpCancelJobBatchFromJobIdDTO(unittest.TestCase): + """DpCancelJobBatchFromJobIdDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DpCancelJobBatchFromJobIdDTO: + """Test DpCancelJobBatchFromJobIdDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DpCancelJobBatchFromJobIdDTO` + """ + model = DpCancelJobBatchFromJobIdDTO() + if include_optional: + return DpCancelJobBatchFromJobIdDTO( + job_ids = [ + '' + ] + ) + else: + return DpCancelJobBatchFromJobIdDTO( + ) + """ + + def testDpCancelJobBatchFromJobIdDTO(self): + """Test DpCancelJobBatchFromJobIdDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dp_job_cancellation_result_dto.py b/src/visier_platform_sdk/test/test_dp_job_cancellation_result_dto.py new file mode 100644 index 0000000000..3e1550de94 --- /dev/null +++ b/src/visier_platform_sdk/test/test_dp_job_cancellation_result_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dp_job_cancellation_result_dto import DpJobCancellationResultDTO + +class TestDpJobCancellationResultDTO(unittest.TestCase): + """DpJobCancellationResultDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DpJobCancellationResultDTO: + """Test DpJobCancellationResultDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DpJobCancellationResultDTO` + """ + model = DpJobCancellationResultDTO() + if include_optional: + return DpJobCancellationResultDTO( + tenant_code = '', + job_id = '', + job_type = '', + parent_job_id = '', + cancel_status = 'CANCEL_FAILED', + job_status = '', + message = '' + ) + else: + return DpJobCancellationResultDTO( + ) + """ + + def testDpJobCancellationResultDTO(self): + """Test DpJobCancellationResultDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dp_job_cancellation_results_dto.py b/src/visier_platform_sdk/test/test_dp_job_cancellation_results_dto.py new file mode 100644 index 0000000000..2f2e6508ca --- /dev/null +++ b/src/visier_platform_sdk/test/test_dp_job_cancellation_results_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dp_job_cancellation_results_dto import DpJobCancellationResultsDTO + +class TestDpJobCancellationResultsDTO(unittest.TestCase): + """DpJobCancellationResultsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DpJobCancellationResultsDTO: + """Test DpJobCancellationResultsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DpJobCancellationResultsDTO` + """ + model = DpJobCancellationResultsDTO() + if include_optional: + return DpJobCancellationResultsDTO( + job_cancellation_results = [ + visier_platform_sdk.models.dp/job_cancellation_result_dto.dp.JobCancellationResultDTO( + tenant_code = '', + job_id = '', + job_type = '', + parent_job_id = '', + cancel_status = 'CANCEL_FAILED', + job_status = '', + message = '', ) + ] + ) + else: + return DpJobCancellationResultsDTO( + ) + """ + + def testDpJobCancellationResultsDTO(self): + """Test DpJobCancellationResultsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_dv_export_status.py b/src/visier_platform_sdk/test/test_dv_export_status.py new file mode 100644 index 0000000000..574f658e2f --- /dev/null +++ b/src/visier_platform_sdk/test/test_dv_export_status.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.dv_export_status import DvExportStatus + +class TestDvExportStatus(unittest.TestCase): + """DvExportStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DvExportStatus: + """Test DvExportStatus + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `DvExportStatus` + """ + model = DvExportStatus() + if include_optional: + return DvExportStatus( + localized_message = '', + error_code = '', + message = '', + rci = '', + user_error = True + ) + else: + return DvExportStatus( + ) + """ + + def testDvExportStatus(self): + """Test DvExportStatus""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_email_domains_api.py b/src/visier_platform_sdk/test/test_email_domains_api.py new file mode 100644 index 0000000000..f9beb732b1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_email_domains_api.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.email_domains_api import EmailDomainsApi + + +class TestEmailDomainsApi(unittest.TestCase): + """EmailDomainsApi unit test stubs""" + + def setUp(self) -> None: + self.api = EmailDomainsApi() + + def tearDown(self) -> None: + pass + + def test_add_allowed_email_domains(self) -> None: + """Test case for add_allowed_email_domains + + Add domains to the list of allowed domains + """ + pass + + def test_delete_allowed_email_domains(self) -> None: + """Test case for delete_allowed_email_domains + + Remove domains from the list of allowed domains + """ + pass + + def test_list_allowed_email_domains(self) -> None: + """Test case for list_allowed_email_domains + + Retrieve a list of allowed email domains + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_encryption_keys_api.py b/src/visier_platform_sdk/test/test_encryption_keys_api.py new file mode 100644 index 0000000000..952002d6ee --- /dev/null +++ b/src/visier_platform_sdk/test/test_encryption_keys_api.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.encryption_keys_api import EncryptionKeysApi + + +class TestEncryptionKeysApi(unittest.TestCase): + """EncryptionKeysApi unit test stubs""" + + def setUp(self) -> None: + self.api = EncryptionKeysApi() + + def tearDown(self) -> None: + pass + + def test_delete_encryption_keys(self) -> None: + """Test case for delete_encryption_keys + + Delete an encryption key + """ + pass + + def test_generate_encryption_keys(self) -> None: + """Test case for generate_encryption_keys + + Generate an encryption key + """ + pass + + def test_list_all_encryption_keys_metadata(self) -> None: + """Test case for list_all_encryption_keys_metadata + + Retrieve a list of all encryption keys + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_extracted_skill.py b/src/visier_platform_sdk/test/test_extracted_skill.py new file mode 100644 index 0000000000..63951c40cc --- /dev/null +++ b/src/visier_platform_sdk/test/test_extracted_skill.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.extracted_skill import ExtractedSkill + +class TestExtractedSkill(unittest.TestCase): + """ExtractedSkill unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ExtractedSkill: + """Test ExtractedSkill + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ExtractedSkill` + """ + model = ExtractedSkill() + if include_optional: + return ExtractedSkill( + id = '', + name = '', + description = '', + score = 56 + ) + else: + return ExtractedSkill( + id = '', + name = '', + description = '', + score = 56, + ) + """ + + def testExtractedSkill(self): + """Test ExtractedSkill""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_generate_impersonation_token_request.py b/src/visier_platform_sdk/test/test_generate_impersonation_token_request.py new file mode 100644 index 0000000000..81ff2955e0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_generate_impersonation_token_request.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.generate_impersonation_token_request import GenerateImpersonationTokenRequest + +class TestGenerateImpersonationTokenRequest(unittest.TestCase): + """GenerateImpersonationTokenRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GenerateImpersonationTokenRequest: + """Test GenerateImpersonationTokenRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GenerateImpersonationTokenRequest` + """ + model = GenerateImpersonationTokenRequest() + if include_optional: + return GenerateImpersonationTokenRequest( + target_username = '' + ) + else: + return GenerateImpersonationTokenRequest( + ) + """ + + def testGenerateImpersonationTokenRequest(self): + """Test GenerateImpersonationTokenRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_google_protobuf_any.py b/src/visier_platform_sdk/test/test_google_protobuf_any.py new file mode 100644 index 0000000000..83acaeb268 --- /dev/null +++ b/src/visier_platform_sdk/test/test_google_protobuf_any.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.google_protobuf_any import GoogleProtobufAny + +class TestGoogleProtobufAny(unittest.TestCase): + """GoogleProtobufAny unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GoogleProtobufAny: + """Test GoogleProtobufAny + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GoogleProtobufAny` + """ + model = GoogleProtobufAny() + if include_optional: + return GoogleProtobufAny( + type = '' + ) + else: + return GoogleProtobufAny( + ) + """ + + def testGoogleProtobufAny(self): + """Test GoogleProtobufAny""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_hierarchy.py b/src/visier_platform_sdk/test/test_hierarchy.py new file mode 100644 index 0000000000..00dadad9f5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_hierarchy.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.hierarchy import Hierarchy + +class TestHierarchy(unittest.TestCase): + """Hierarchy unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Hierarchy: + """Test Hierarchy + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Hierarchy` + """ + model = Hierarchy() + if include_optional: + return Hierarchy( + id = '', + name = '', + description = '' + ) + else: + return Hierarchy( + id = '', + name = '', + ) + """ + + def testHierarchy(self): + """Test Hierarchy""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_job.py b/src/visier_platform_sdk/test/test_job.py new file mode 100644 index 0000000000..3dae148e46 --- /dev/null +++ b/src/visier_platform_sdk/test/test_job.py @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.job import Job + +class TestJob(unittest.TestCase): + """Job unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Job: + """Test Job + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Job` + """ + model = Job() + if include_optional: + return Job( + id = '', + name = '', + description = '', + isco_code = '', + soc_code = '', + alternative_titles = [ + '' + ], + essential_skills = [ + visier_platform_sdk.models.skill.Skill( + id = '', + name = '', + description = '', + skill_group_id = '', + skill_category_id = '', + is_knowledge = True, + skill_type = '', + alternative_titles = [ + '' + ], + remote_index = 1.337, + automation_index = 56, ) + ], + optional_skills = [ + visier_platform_sdk.models.skill.Skill( + id = '', + name = '', + description = '', + skill_group_id = '', + skill_category_id = '', + is_knowledge = True, + skill_type = '', + alternative_titles = [ + '' + ], + remote_index = 1.337, + automation_index = 56, ) + ], + remote_index = 1.337, + automation_index = 56 + ) + else: + return Job( + id = '', + name = '', + description = '', + alternative_titles = [ + '' + ], + essential_skills = [ + visier_platform_sdk.models.skill.Skill( + id = '', + name = '', + description = '', + skill_group_id = '', + skill_category_id = '', + is_knowledge = True, + skill_type = '', + alternative_titles = [ + '' + ], + remote_index = 1.337, + automation_index = 56, ) + ], + optional_skills = [ + visier_platform_sdk.models.skill.Skill( + id = '', + name = '', + description = '', + skill_group_id = '', + skill_category_id = '', + is_knowledge = True, + skill_type = '', + alternative_titles = [ + '' + ], + remote_index = 1.337, + automation_index = 56, ) + ], + ) + """ + + def testJob(self): + """Test Job""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_job_entry.py b/src/visier_platform_sdk/test/test_job_entry.py new file mode 100644 index 0000000000..b56b1e9315 --- /dev/null +++ b/src/visier_platform_sdk/test/test_job_entry.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.job_entry import JobEntry + +class TestJobEntry(unittest.TestCase): + """JobEntry unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> JobEntry: + """Test JobEntry + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `JobEntry` + """ + model = JobEntry() + if include_optional: + return JobEntry( + id = '', + name = '', + description = '' + ) + else: + return JobEntry( + id = '', + name = '', + description = '', + ) + """ + + def testJobEntry(self): + """Test JobEntry""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_job_feedback_input.py b/src/visier_platform_sdk/test/test_job_feedback_input.py new file mode 100644 index 0000000000..3cc42e4f72 --- /dev/null +++ b/src/visier_platform_sdk/test/test_job_feedback_input.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.job_feedback_input import JobFeedbackInput + +class TestJobFeedbackInput(unittest.TestCase): + """JobFeedbackInput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> JobFeedbackInput: + """Test JobFeedbackInput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `JobFeedbackInput` + """ + model = JobFeedbackInput() + if include_optional: + return JobFeedbackInput( + term = '', + naics_code = '', + additional_comments = '' + ) + else: + return JobFeedbackInput( + term = '', + ) + """ + + def testJobFeedbackInput(self): + """Test JobFeedbackInput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_job_search_failure_output.py b/src/visier_platform_sdk/test/test_job_search_failure_output.py new file mode 100644 index 0000000000..295161d17d --- /dev/null +++ b/src/visier_platform_sdk/test/test_job_search_failure_output.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.job_search_failure_output import JobSearchFailureOutput + +class TestJobSearchFailureOutput(unittest.TestCase): + """JobSearchFailureOutput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> JobSearchFailureOutput: + """Test JobSearchFailureOutput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `JobSearchFailureOutput` + """ + model = JobSearchFailureOutput() + if include_optional: + return JobSearchFailureOutput( + http_status = '', + message = '', + rci = '', + error_code = '' + ) + else: + return JobSearchFailureOutput( + http_status = '', + message = '', + rci = '', + error_code = '', + ) + """ + + def testJobSearchFailureOutput(self): + """Test JobSearchFailureOutput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_job_search_input.py b/src/visier_platform_sdk/test/test_job_search_input.py new file mode 100644 index 0000000000..3324bb9205 --- /dev/null +++ b/src/visier_platform_sdk/test/test_job_search_input.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.job_search_input import JobSearchInput + +class TestJobSearchInput(unittest.TestCase): + """JobSearchInput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> JobSearchInput: + """Test JobSearchInput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `JobSearchInput` + """ + model = JobSearchInput() + if include_optional: + return JobSearchInput( + job_ids = [ + '' + ] + ) + else: + return JobSearchInput( + job_ids = [ + '' + ], + ) + """ + + def testJobSearchInput(self): + """Test JobSearchInput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_job_search_output.py b/src/visier_platform_sdk/test/test_job_search_output.py new file mode 100644 index 0000000000..0b3a2dd4f9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_job_search_output.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.job_search_output import JobSearchOutput + +class TestJobSearchOutput(unittest.TestCase): + """JobSearchOutput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> JobSearchOutput: + """Test JobSearchOutput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `JobSearchOutput` + """ + model = JobSearchOutput() + if include_optional: + return JobSearchOutput( + successes = [ + visier_platform_sdk.models.dimension_member.DimensionMember( + id = '', + name = '', + description = '', + has_benchmark_value = True, + has_children = True, + status = 'active', + display_id = '', + short_description_sections = [ + visier_platform_sdk.models.description_entry.DescriptionEntry( + label = '', + text = '', ) + ], + job_domain = '', + job_subdomain = '', + typical_titles = [ + '' + ], + related_jobs = [ + '' + ], + naics_id = '', + naics_name = '', + naics_description = '', + soc_code = '', + soc_name = '', + soc_codes = visier_platform_sdk.models.soc_codes.socCodes(), + soc_names = visier_platform_sdk.models.soc_names.socNames(), ) + ], + failures = [ + visier_platform_sdk.models.job_search_failure_output.JobSearchFailureOutput( + http_status = '', + message = '', + rci = '', + error_code = '', ) + ] + ) + else: + return JobSearchOutput( + successes = [ + visier_platform_sdk.models.dimension_member.DimensionMember( + id = '', + name = '', + description = '', + has_benchmark_value = True, + has_children = True, + status = 'active', + display_id = '', + short_description_sections = [ + visier_platform_sdk.models.description_entry.DescriptionEntry( + label = '', + text = '', ) + ], + job_domain = '', + job_subdomain = '', + typical_titles = [ + '' + ], + related_jobs = [ + '' + ], + naics_id = '', + naics_name = '', + naics_description = '', + soc_code = '', + soc_name = '', + soc_codes = visier_platform_sdk.models.soc_codes.socCodes(), + soc_names = visier_platform_sdk.models.soc_names.socNames(), ) + ], + failures = [ + visier_platform_sdk.models.job_search_failure_output.JobSearchFailureOutput( + http_status = '', + message = '', + rci = '', + error_code = '', ) + ], + ) + """ + + def testJobSearchOutput(self): + """Test JobSearchOutput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_job_standardization_input.py b/src/visier_platform_sdk/test/test_job_standardization_input.py new file mode 100644 index 0000000000..eb50d83ffb --- /dev/null +++ b/src/visier_platform_sdk/test/test_job_standardization_input.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.job_standardization_input import JobStandardizationInput + +class TestJobStandardizationInput(unittest.TestCase): + """JobStandardizationInput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> JobStandardizationInput: + """Test JobStandardizationInput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `JobStandardizationInput` + """ + model = JobStandardizationInput() + if include_optional: + return JobStandardizationInput( + terms = [ + '' + ], + naics_code = '', + num_matches = 56, + semantic_only = True, + lexical_only = True, + typical_titles_search = True + ) + else: + return JobStandardizationInput( + terms = [ + '' + ], + ) + """ + + def testJobStandardizationInput(self): + """Test JobStandardizationInput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_job_standardization_input_skills.py b/src/visier_platform_sdk/test/test_job_standardization_input_skills.py new file mode 100644 index 0000000000..e4ad115eff --- /dev/null +++ b/src/visier_platform_sdk/test/test_job_standardization_input_skills.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.job_standardization_input_skills import JobStandardizationInputSkills + +class TestJobStandardizationInputSkills(unittest.TestCase): + """JobStandardizationInputSkills unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> JobStandardizationInputSkills: + """Test JobStandardizationInputSkills + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `JobStandardizationInputSkills` + """ + model = JobStandardizationInputSkills() + if include_optional: + return JobStandardizationInputSkills( + jobs = [ + '' + ], + naics_code = '' + ) + else: + return JobStandardizationInputSkills( + jobs = [ + '' + ], + ) + """ + + def testJobStandardizationInputSkills(self): + """Test JobStandardizationInputSkills""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_jobs_library_api.py b/src/visier_platform_sdk/test/test_jobs_library_api.py new file mode 100644 index 0000000000..23374b02cc --- /dev/null +++ b/src/visier_platform_sdk/test/test_jobs_library_api.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.jobs_library_api import JobsLibraryApi + + +class TestJobsLibraryApi(unittest.TestCase): + """JobsLibraryApi unit test stubs""" + + def setUp(self) -> None: + self.api = JobsLibraryApi() + + def tearDown(self) -> None: + pass + + def test_get_job(self) -> None: + """Test case for get_job + + Get job details by ID + """ + pass + + def test_list_jobs(self) -> None: + """Test case for list_jobs + + Retrieve a list of jobs + """ + pass + + def test_search_job(self) -> None: + """Test case for search_job + + Search jobs + """ + pass + + def test_standardize_jobs(self) -> None: + """Test case for standardize_jobs + + Standardize custom job titles + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_location_search_failure_output.py b/src/visier_platform_sdk/test/test_location_search_failure_output.py new file mode 100644 index 0000000000..9254469c70 --- /dev/null +++ b/src/visier_platform_sdk/test/test_location_search_failure_output.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.location_search_failure_output import LocationSearchFailureOutput + +class TestLocationSearchFailureOutput(unittest.TestCase): + """LocationSearchFailureOutput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> LocationSearchFailureOutput: + """Test LocationSearchFailureOutput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `LocationSearchFailureOutput` + """ + model = LocationSearchFailureOutput() + if include_optional: + return LocationSearchFailureOutput( + uuid = '', + http_status = '', + message = '', + rci = '', + error_code = '' + ) + else: + return LocationSearchFailureOutput( + uuid = '', + http_status = '', + message = '', + rci = '', + error_code = '', + ) + """ + + def testLocationSearchFailureOutput(self): + """Test LocationSearchFailureOutput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_location_search_input.py b/src/visier_platform_sdk/test/test_location_search_input.py new file mode 100644 index 0000000000..0f4b28380a --- /dev/null +++ b/src/visier_platform_sdk/test/test_location_search_input.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.location_search_input import LocationSearchInput + +class TestLocationSearchInput(unittest.TestCase): + """LocationSearchInput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> LocationSearchInput: + """Test LocationSearchInput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `LocationSearchInput` + """ + model = LocationSearchInput() + if include_optional: + return LocationSearchInput( + search_inputs = [ + visier_platform_sdk.models.location_search_input.LocationSearchInput( + uuid = '', + country_code = '', + postal_code = '', ) + ], + has_benchmark_value = True + ) + else: + return LocationSearchInput( + search_inputs = [ + visier_platform_sdk.models.location_search_input.LocationSearchInput( + uuid = '', + country_code = '', + postal_code = '', ) + ], + ) + """ + + def testLocationSearchInput(self): + """Test LocationSearchInput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_location_search_input1.py b/src/visier_platform_sdk/test/test_location_search_input1.py new file mode 100644 index 0000000000..9e8591f772 --- /dev/null +++ b/src/visier_platform_sdk/test/test_location_search_input1.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.location_search_input1 import LocationSearchInput1 + +class TestLocationSearchInput1(unittest.TestCase): + """LocationSearchInput1 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> LocationSearchInput1: + """Test LocationSearchInput1 + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `LocationSearchInput1` + """ + model = LocationSearchInput1() + if include_optional: + return LocationSearchInput1( + uuid = '', + country_code = '', + postal_code = '' + ) + else: + return LocationSearchInput1( + uuid = '', + country_code = '', + postal_code = '', + ) + """ + + def testLocationSearchInput1(self): + """Test LocationSearchInput1""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_location_search_output.py b/src/visier_platform_sdk/test/test_location_search_output.py new file mode 100644 index 0000000000..de67e21fca --- /dev/null +++ b/src/visier_platform_sdk/test/test_location_search_output.py @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.location_search_output import LocationSearchOutput + +class TestLocationSearchOutput(unittest.TestCase): + """LocationSearchOutput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> LocationSearchOutput: + """Test LocationSearchOutput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `LocationSearchOutput` + """ + model = LocationSearchOutput() + if include_optional: + return LocationSearchOutput( + successes = [ + visier_platform_sdk.models.location_search_successful_output.LocationSearchSuccessfulOutput( + uuid = '', + results = [ + visier_platform_sdk.models.dimension_member.DimensionMember( + id = '', + name = '', + description = '', + has_benchmark_value = True, + has_children = True, + status = 'active', + display_id = '', + short_description_sections = [ + visier_platform_sdk.models.description_entry.DescriptionEntry( + label = '', + text = '', ) + ], + job_domain = '', + job_subdomain = '', + typical_titles = [ + '' + ], + related_jobs = [ + '' + ], + naics_id = '', + naics_name = '', + naics_description = '', + soc_code = '', + soc_name = '', + soc_codes = visier_platform_sdk.models.soc_codes.socCodes(), + soc_names = visier_platform_sdk.models.soc_names.socNames(), ) + ], ) + ], + failures = [ + visier_platform_sdk.models.location_search_failure_output.LocationSearchFailureOutput( + uuid = '', + http_status = '', + message = '', + rci = '', + error_code = '', ) + ] + ) + else: + return LocationSearchOutput( + successes = [ + visier_platform_sdk.models.location_search_successful_output.LocationSearchSuccessfulOutput( + uuid = '', + results = [ + visier_platform_sdk.models.dimension_member.DimensionMember( + id = '', + name = '', + description = '', + has_benchmark_value = True, + has_children = True, + status = 'active', + display_id = '', + short_description_sections = [ + visier_platform_sdk.models.description_entry.DescriptionEntry( + label = '', + text = '', ) + ], + job_domain = '', + job_subdomain = '', + typical_titles = [ + '' + ], + related_jobs = [ + '' + ], + naics_id = '', + naics_name = '', + naics_description = '', + soc_code = '', + soc_name = '', + soc_codes = visier_platform_sdk.models.soc_codes.socCodes(), + soc_names = visier_platform_sdk.models.soc_names.socNames(), ) + ], ) + ], + failures = [ + visier_platform_sdk.models.location_search_failure_output.LocationSearchFailureOutput( + uuid = '', + http_status = '', + message = '', + rci = '', + error_code = '', ) + ], + ) + """ + + def testLocationSearchOutput(self): + """Test LocationSearchOutput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_location_search_successful_output.py b/src/visier_platform_sdk/test/test_location_search_successful_output.py new file mode 100644 index 0000000000..174a2c55d3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_location_search_successful_output.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.location_search_successful_output import LocationSearchSuccessfulOutput + +class TestLocationSearchSuccessfulOutput(unittest.TestCase): + """LocationSearchSuccessfulOutput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> LocationSearchSuccessfulOutput: + """Test LocationSearchSuccessfulOutput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `LocationSearchSuccessfulOutput` + """ + model = LocationSearchSuccessfulOutput() + if include_optional: + return LocationSearchSuccessfulOutput( + uuid = '', + results = [ + visier_platform_sdk.models.dimension_member.DimensionMember( + id = '', + name = '', + description = '', + has_benchmark_value = True, + has_children = True, + status = 'active', + display_id = '', + short_description_sections = [ + visier_platform_sdk.models.description_entry.DescriptionEntry( + label = '', + text = '', ) + ], + job_domain = '', + job_subdomain = '', + typical_titles = [ + '' + ], + related_jobs = [ + '' + ], + naics_id = '', + naics_name = '', + naics_description = '', + soc_code = '', + soc_name = '', + soc_codes = visier_platform_sdk.models.soc_codes.socCodes(), + soc_names = visier_platform_sdk.models.soc_names.socNames(), ) + ] + ) + else: + return LocationSearchSuccessfulOutput( + uuid = '', + results = [ + visier_platform_sdk.models.dimension_member.DimensionMember( + id = '', + name = '', + description = '', + has_benchmark_value = True, + has_children = True, + status = 'active', + display_id = '', + short_description_sections = [ + visier_platform_sdk.models.description_entry.DescriptionEntry( + label = '', + text = '', ) + ], + job_domain = '', + job_subdomain = '', + typical_titles = [ + '' + ], + related_jobs = [ + '' + ], + naics_id = '', + naics_name = '', + naics_description = '', + soc_code = '', + soc_name = '', + soc_codes = visier_platform_sdk.models.soc_codes.socCodes(), + soc_names = visier_platform_sdk.models.soc_names.socNames(), ) + ], + ) + """ + + def testLocationSearchSuccessfulOutput(self): + """Test LocationSearchSuccessfulOutput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_network_subnets_api.py b/src/visier_platform_sdk/test/test_network_subnets_api.py new file mode 100644 index 0000000000..2a554318cf --- /dev/null +++ b/src/visier_platform_sdk/test/test_network_subnets_api.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.network_subnets_api import NetworkSubnetsApi + + +class TestNetworkSubnetsApi(unittest.TestCase): + """NetworkSubnetsApi unit test stubs""" + + def setUp(self) -> None: + self.api = NetworkSubnetsApi() + + def tearDown(self) -> None: + pass + + def test_add_api_subnets(self) -> None: + """Test case for add_api_subnets + + Add API network subnets + """ + pass + + def test_delete_api_subnets(self) -> None: + """Test case for delete_api_subnets + + Delete API network subnets + """ + pass + + def test_get_api_subnets(self) -> None: + """Test case for get_api_subnets + + Retrieve a list of API network subnets + """ + pass + + def test_set_api_subnets(self) -> None: + """Test case for set_api_subnets + + Update API network subnets + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_o_auth2_api.py b/src/visier_platform_sdk/test/test_o_auth2_api.py new file mode 100644 index 0000000000..78a46fc88c --- /dev/null +++ b/src/visier_platform_sdk/test/test_o_auth2_api.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.o_auth2_api import OAuth2Api + + +class TestOAuth2Api(unittest.TestCase): + """OAuth2Api unit test stubs""" + + def setUp(self) -> None: + self.api = OAuth2Api() + + def tearDown(self) -> None: + pass + + def test_o_auth2_token(self) -> None: + """Test case for o_auth2_token + + Request a JSON Web Token + """ + pass + + def test_oauth2_authorize(self) -> None: + """Test case for oauth2_authorize + + Request an authorization code + """ + pass + + def test_user_info(self) -> None: + """Test case for user_info + + Retrieve user-specific metadata + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_object_configuration_api.py b/src/visier_platform_sdk/test/test_object_configuration_api.py new file mode 100644 index 0000000000..c17fe12af2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_object_configuration_api.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.object_configuration_api import ObjectConfigurationApi + + +class TestObjectConfigurationApi(unittest.TestCase): + """ObjectConfigurationApi unit test stubs""" + + def setUp(self) -> None: + self.api = ObjectConfigurationApi() + + def tearDown(self) -> None: + pass + + def test_get_calculation_concept(self) -> None: + """Test case for get_calculation_concept + + Retrieve the configuration of a calculation concept + """ + pass + + def test_get_calculation_concepts(self) -> None: + """Test case for get_calculation_concepts + + Retrieve all calculation concepts + """ + pass + + def test_get_selection_concept(self) -> None: + """Test case for get_selection_concept + + Retrieve the configuration of a selection concept + """ + pass + + def test_get_selection_concepts(self) -> None: + """Test case for get_selection_concepts + + Retrieve all selection concepts + """ + pass + + def test_map_calculation_concept(self) -> None: + """Test case for map_calculation_concept + + Map dimension members to nodes in a calculation concept + """ + pass + + def test_map_selection_concept(self) -> None: + """Test case for map_selection_concept + + Map dimension members to a selection concept + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_output_entry.py b/src/visier_platform_sdk/test/test_output_entry.py new file mode 100644 index 0000000000..8e4ffdbab1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_output_entry.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.output_entry import OutputEntry + +class TestOutputEntry(unittest.TestCase): + """OutputEntry unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> OutputEntry: + """Test OutputEntry + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `OutputEntry` + """ + model = OutputEntry() + if include_optional: + return OutputEntry( + job = '', + matches = [ + visier_platform_sdk.models.dimension_member.DimensionMember( + id = '', + name = '', + description = '', + has_benchmark_value = True, + has_children = True, + status = 'active', + display_id = '', + short_description_sections = [ + visier_platform_sdk.models.description_entry.DescriptionEntry( + label = '', + text = '', ) + ], + job_domain = '', + job_subdomain = '', + typical_titles = [ + '' + ], + related_jobs = [ + '' + ], + naics_id = '', + naics_name = '', + naics_description = '', + soc_code = '', + soc_name = '', + soc_codes = visier_platform_sdk.models.soc_codes.socCodes(), + soc_names = visier_platform_sdk.models.soc_names.socNames(), ) + ] + ) + else: + return OutputEntry( + job = '', + matches = [ + visier_platform_sdk.models.dimension_member.DimensionMember( + id = '', + name = '', + description = '', + has_benchmark_value = True, + has_children = True, + status = 'active', + display_id = '', + short_description_sections = [ + visier_platform_sdk.models.description_entry.DescriptionEntry( + label = '', + text = '', ) + ], + job_domain = '', + job_subdomain = '', + typical_titles = [ + '' + ], + related_jobs = [ + '' + ], + naics_id = '', + naics_name = '', + naics_description = '', + soc_code = '', + soc_name = '', + soc_codes = visier_platform_sdk.models.soc_codes.socCodes(), + soc_names = visier_platform_sdk.models.soc_names.socNames(), ) + ], + ) + """ + + def testOutputEntry(self): + """Test OutputEntry""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_output_entry1.py b/src/visier_platform_sdk/test/test_output_entry1.py new file mode 100644 index 0000000000..dab89ba2a5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_output_entry1.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.output_entry1 import OutputEntry1 + +class TestOutputEntry1(unittest.TestCase): + """OutputEntry1 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> OutputEntry1: + """Test OutputEntry1 + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `OutputEntry1` + """ + model = OutputEntry1() + if include_optional: + return OutputEntry1( + job = '', + matches = [ + visier_platform_sdk.models.output_entry_1_matches_inner.OutputEntry_1_matches_inner( + id = '', + name = '', + description = '', + score = 56, ) + ] + ) + else: + return OutputEntry1( + job = '', + matches = [ + visier_platform_sdk.models.output_entry_1_matches_inner.OutputEntry_1_matches_inner( + id = '', + name = '', + description = '', + score = 56, ) + ], + ) + """ + + def testOutputEntry1(self): + """Test OutputEntry1""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_output_entry1_matches_inner.py b/src/visier_platform_sdk/test/test_output_entry1_matches_inner.py new file mode 100644 index 0000000000..a51a624a0e --- /dev/null +++ b/src/visier_platform_sdk/test/test_output_entry1_matches_inner.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.output_entry1_matches_inner import OutputEntry1MatchesInner + +class TestOutputEntry1MatchesInner(unittest.TestCase): + """OutputEntry1MatchesInner unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> OutputEntry1MatchesInner: + """Test OutputEntry1MatchesInner + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `OutputEntry1MatchesInner` + """ + model = OutputEntry1MatchesInner() + if include_optional: + return OutputEntry1MatchesInner( + id = '', + name = '', + description = '', + score = 56 + ) + else: + return OutputEntry1MatchesInner( + id = '', + name = '', + description = '', + score = 56, + ) + """ + + def testOutputEntry1MatchesInner(self): + """Test OutputEntry1MatchesInner""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_permissions_api.py b/src/visier_platform_sdk/test/test_permissions_api.py new file mode 100644 index 0000000000..416d6133e1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_permissions_api.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.permissions_api import PermissionsApi + + +class TestPermissionsApi(unittest.TestCase): + """PermissionsApi unit test stubs""" + + def setUp(self) -> None: + self.api = PermissionsApi() + + def tearDown(self) -> None: + pass + + def test_create_data_access_sets(self) -> None: + """Test case for create_data_access_sets + + Create shareable data access sets + """ + pass + + def test_create_permissions(self) -> None: + """Test case for create_permissions + + Create permissions + """ + pass + + def test_delete_permissions(self) -> None: + """Test case for delete_permissions + + Delete permissions + """ + pass + + def test_get_capabilities(self) -> None: + """Test case for get_capabilities + + Retrieve a list of all permission capabilities + """ + pass + + def test_get_capability(self) -> None: + """Test case for get_capability + + Retrieve a permission capability's details + """ + pass + + def test_get_content_package(self) -> None: + """Test case for get_content_package + + Retrieve a content package's details + """ + pass + + def test_get_content_packages(self) -> None: + """Test case for get_content_packages + + Retrieve a list of all content packages + """ + pass + + def test_get_data_access_set(self) -> None: + """Test case for get_data_access_set + + Retrieve a data access set's details + """ + pass + + def test_get_data_access_sets(self) -> None: + """Test case for get_data_access_sets + + Retrieve a list of all data access sets + """ + pass + + def test_get_data_security_objects(self) -> None: + """Test case for get_data_security_objects + + Retrieve a list of data security objects + """ + pass + + def test_get_permission(self) -> None: + """Test case for get_permission + + Retrieve a permission's details + """ + pass + + def test_get_permissions(self) -> None: + """Test case for get_permissions + + Retrieve a list of all permissions + """ + pass + + def test_update_permissions(self) -> None: + """Test case for update_permissions + + Update permissions + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_pgp_key_api.py b/src/visier_platform_sdk/test/test_pgp_key_api.py new file mode 100644 index 0000000000..57fe62d667 --- /dev/null +++ b/src/visier_platform_sdk/test/test_pgp_key_api.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.pgp_key_api import PGPKeyApi + + +class TestPGPKeyApi(unittest.TestCase): + """PGPKeyApi unit test stubs""" + + def setUp(self) -> None: + self.api = PGPKeyApi() + + def tearDown(self) -> None: + pass + + def test_delete_pgp_key_pair(self) -> None: + """Test case for delete_pgp_key_pair + + Delete a PGP key pair + """ + pass + + def test_generate_pgp_key_pair(self) -> None: + """Test case for generate_pgp_key_pair + + Download a public encryption key + """ + pass + + def test_get_all_pgp_public_keys(self) -> None: + """Test case for get_all_pgp_public_keys + + Retrieve all PGP public keys + """ + pass + + def test_get_pgp_public_key(self) -> None: + """Test case for get_pgp_public_key + + Retrieve a PGP public key using the key ID + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_plan_data_load_change_dto.py b/src/visier_platform_sdk/test/test_plan_data_load_change_dto.py new file mode 100644 index 0000000000..f18629f427 --- /dev/null +++ b/src/visier_platform_sdk/test/test_plan_data_load_change_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.plan_data_load_change_dto import PlanDataLoadChangeDTO + +class TestPlanDataLoadChangeDTO(unittest.TestCase): + """PlanDataLoadChangeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanDataLoadChangeDTO: + """Test PlanDataLoadChangeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanDataLoadChangeDTO` + """ + model = PlanDataLoadChangeDTO() + if include_optional: + return PlanDataLoadChangeDTO( + row_members = [ + '' + ], + period = '', + old_value = 1.337, + new_value = 1.337 + ) + else: + return PlanDataLoadChangeDTO( + ) + """ + + def testPlanDataLoadChangeDTO(self): + """Test PlanDataLoadChangeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_plan_data_load_change_list_dto.py b/src/visier_platform_sdk/test/test_plan_data_load_change_list_dto.py new file mode 100644 index 0000000000..3241d478b4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_plan_data_load_change_list_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.plan_data_load_change_list_dto import PlanDataLoadChangeListDTO + +class TestPlanDataLoadChangeListDTO(unittest.TestCase): + """PlanDataLoadChangeListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanDataLoadChangeListDTO: + """Test PlanDataLoadChangeListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanDataLoadChangeListDTO` + """ + model = PlanDataLoadChangeListDTO() + if include_optional: + return PlanDataLoadChangeListDTO( + plan_item = '', + changes = [ + visier_platform_sdk.models.plan_data_load_change_dto.PlanDataLoadChangeDTO( + row_members = [ + '' + ], + period = '', + old_value = 1.337, + new_value = 1.337, ) + ] + ) + else: + return PlanDataLoadChangeListDTO( + ) + """ + + def testPlanDataLoadChangeListDTO(self): + """Test PlanDataLoadChangeListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_plan_data_upload_response_dto.py b/src/visier_platform_sdk/test/test_plan_data_upload_response_dto.py new file mode 100644 index 0000000000..e55e829739 --- /dev/null +++ b/src/visier_platform_sdk/test/test_plan_data_upload_response_dto.py @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.plan_data_upload_response_dto import PlanDataUploadResponseDTO + +class TestPlanDataUploadResponseDTO(unittest.TestCase): + """PlanDataUploadResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanDataUploadResponseDTO: + """Test PlanDataUploadResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanDataUploadResponseDTO` + """ + model = PlanDataUploadResponseDTO() + if include_optional: + return PlanDataUploadResponseDTO( + updated_cells_count = 56, + potential_updated_cells_count = 56, + errors = [ + visier_platform_sdk.models.planning/plan_data_load_error_dto.planning.PlanDataLoadErrorDTO( + row = 56, + rci = '', + error_message = '', ) + ], + changelists = [ + visier_platform_sdk.models.plan_data_load_change_list_dto.PlanDataLoadChangeListDTO( + plan_item = '', + changes = [ + visier_platform_sdk.models.plan_data_load_change_dto.PlanDataLoadChangeDTO( + row_members = [ + '' + ], + period = '', + old_value = 1.337, + new_value = 1.337, ) + ], ) + ] + ) + else: + return PlanDataUploadResponseDTO( + ) + """ + + def testPlanDataUploadResponseDTO(self): + """Test PlanDataUploadResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_plan_row_data_load_response_dto.py b/src/visier_platform_sdk/test/test_plan_row_data_load_response_dto.py new file mode 100644 index 0000000000..c90b280a7c --- /dev/null +++ b/src/visier_platform_sdk/test/test_plan_row_data_load_response_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.plan_row_data_load_response_dto import PlanRowDataLoadResponseDTO + +class TestPlanRowDataLoadResponseDTO(unittest.TestCase): + """PlanRowDataLoadResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanRowDataLoadResponseDTO: + """Test PlanRowDataLoadResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanRowDataLoadResponseDTO` + """ + model = PlanRowDataLoadResponseDTO() + if include_optional: + return PlanRowDataLoadResponseDTO( + added_rows_count = 56, + removed_rows_count = 56, + potential_added_rows_count = 56, + potential_removed_rows_count = 56, + errors = [ + visier_platform_sdk.models.planning/plan_data_load_error_dto.planning.PlanDataLoadErrorDTO( + row = 56, + rci = '', + error_message = '', ) + ], + custom_members = [ + visier_platform_sdk.models.planning/plan_segment_level_member_dto.planning.PlanSegmentLevelMemberDTO( + id = '', + display_name = '', + is_custom = True, + parent_id = '', ) + ] + ) + else: + return PlanRowDataLoadResponseDTO( + ) + """ + + def testPlanRowDataLoadResponseDTO(self): + """Test PlanRowDataLoadResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_data_load_api.py b/src/visier_platform_sdk/test/test_planning_data_load_api.py new file mode 100644 index 0000000000..a7265852e2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_data_load_api.py @@ -0,0 +1,46 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.planning_data_load_api import PlanningDataLoadApi + + +class TestPlanningDataLoadApi(unittest.TestCase): + """PlanningDataLoadApi unit test stubs""" + + def setUp(self) -> None: + self.api = PlanningDataLoadApi() + + def tearDown(self) -> None: + pass + + def test_plan_data_load_plan_data_upload(self) -> None: + """Test case for plan_data_load_plan_data_upload + + Upload plan data + """ + pass + + def test_plan_data_load_plan_row_data_load(self) -> None: + """Test case for plan_data_load_plan_row_data_load + + Add or remove plan rows + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_get_plan_list_response_dto.py b/src/visier_platform_sdk/test/test_planning_get_plan_list_response_dto.py new file mode 100644 index 0000000000..b15eb5a544 --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_get_plan_list_response_dto.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_get_plan_list_response_dto import PlanningGetPlanListResponseDTO + +class TestPlanningGetPlanListResponseDTO(unittest.TestCase): + """PlanningGetPlanListResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningGetPlanListResponseDTO: + """Test PlanningGetPlanListResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningGetPlanListResponseDTO` + """ + model = PlanningGetPlanListResponseDTO() + if include_optional: + return PlanningGetPlanListResponseDTO( + plans = [ + visier_platform_sdk.models.planning/plan_info_dto.planning.PlanInfoDTO( + uuid = '', + display_name = '', + model_id = '', + scenarios = [ + visier_platform_sdk.models.planning/scenario_info_dto.planning.ScenarioInfoDTO( + uuid = '', + display_name = '', + versioned_scenario_id = '', ) + ], + parent_plan_uuid = '', + currency_code = '', ) + ], + page = 56 + ) + else: + return PlanningGetPlanListResponseDTO( + ) + """ + + def testPlanningGetPlanListResponseDTO(self): + """Test PlanningGetPlanListResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_plan_data_load_error_dto.py b/src/visier_platform_sdk/test/test_planning_plan_data_load_error_dto.py new file mode 100644 index 0000000000..726d45fdfe --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_plan_data_load_error_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_plan_data_load_error_dto import PlanningPlanDataLoadErrorDTO + +class TestPlanningPlanDataLoadErrorDTO(unittest.TestCase): + """PlanningPlanDataLoadErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningPlanDataLoadErrorDTO: + """Test PlanningPlanDataLoadErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningPlanDataLoadErrorDTO` + """ + model = PlanningPlanDataLoadErrorDTO() + if include_optional: + return PlanningPlanDataLoadErrorDTO( + row = 56, + rci = '', + error_message = '' + ) + else: + return PlanningPlanDataLoadErrorDTO( + ) + """ + + def testPlanningPlanDataLoadErrorDTO(self): + """Test PlanningPlanDataLoadErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_plan_info_dto.py b/src/visier_platform_sdk/test/test_planning_plan_info_dto.py new file mode 100644 index 0000000000..cf86c107c6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_plan_info_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_plan_info_dto import PlanningPlanInfoDTO + +class TestPlanningPlanInfoDTO(unittest.TestCase): + """PlanningPlanInfoDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningPlanInfoDTO: + """Test PlanningPlanInfoDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningPlanInfoDTO` + """ + model = PlanningPlanInfoDTO() + if include_optional: + return PlanningPlanInfoDTO( + uuid = '', + display_name = '', + model_id = '', + scenarios = [ + visier_platform_sdk.models.planning/scenario_info_dto.planning.ScenarioInfoDTO( + uuid = '', + display_name = '', + versioned_scenario_id = '', ) + ], + parent_plan_uuid = '', + currency_code = '' + ) + else: + return PlanningPlanInfoDTO( + ) + """ + + def testPlanningPlanInfoDTO(self): + """Test PlanningPlanInfoDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_plan_item_dto.py b/src/visier_platform_sdk/test/test_planning_plan_item_dto.py new file mode 100644 index 0000000000..2e3a03d558 --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_plan_item_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_plan_item_dto import PlanningPlanItemDTO + +class TestPlanningPlanItemDTO(unittest.TestCase): + """PlanningPlanItemDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningPlanItemDTO: + """Test PlanningPlanItemDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningPlanItemDTO` + """ + model = PlanningPlanItemDTO() + if include_optional: + return PlanningPlanItemDTO( + id = '', + display_name = '', + data_type = 'unknown' + ) + else: + return PlanningPlanItemDTO( + ) + """ + + def testPlanningPlanItemDTO(self): + """Test PlanningPlanItemDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_plan_schema_dto.py b/src/visier_platform_sdk/test/test_planning_plan_schema_dto.py new file mode 100644 index 0000000000..27cc00ec3e --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_plan_schema_dto.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_plan_schema_dto import PlanningPlanSchemaDTO + +class TestPlanningPlanSchemaDTO(unittest.TestCase): + """PlanningPlanSchemaDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningPlanSchemaDTO: + """Test PlanningPlanSchemaDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningPlanSchemaDTO` + """ + model = PlanningPlanSchemaDTO() + if include_optional: + return PlanningPlanSchemaDTO( + plan_items = [ + visier_platform_sdk.models.planning/plan_item_dto.planning.PlanItemDTO( + id = '', + display_name = '', + data_type = 'unknown', ) + ], + time_periods = [ + visier_platform_sdk.models.planning/plan_time_period_dto.planning.PlanTimePeriodDTO( + date = '', + display_name = '', ) + ], + plan_segment_levels = [ + visier_platform_sdk.models.planning/plan_segment_level_dto.planning.PlanSegmentLevelDTO( + id = '', + display_name = '', + order = 56, + segment_id = '', + segment_display_name = '', ) + ], + plan_segment_level_members = [ + visier_platform_sdk.models.planning/plan_segment_level_member_list_dto.planning.PlanSegmentLevelMemberListDTO( + segment_level_id = '', + members = [ + visier_platform_sdk.models.planning/plan_segment_level_member_dto.planning.PlanSegmentLevelMemberDTO( + id = '', + display_name = '', + is_custom = True, + parent_id = '', ) + ], + segment_id = '', ) + ] + ) + else: + return PlanningPlanSchemaDTO( + ) + """ + + def testPlanningPlanSchemaDTO(self): + """Test PlanningPlanSchemaDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_plan_segment_level_dto.py b/src/visier_platform_sdk/test/test_planning_plan_segment_level_dto.py new file mode 100644 index 0000000000..09ff4da6e6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_plan_segment_level_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_plan_segment_level_dto import PlanningPlanSegmentLevelDTO + +class TestPlanningPlanSegmentLevelDTO(unittest.TestCase): + """PlanningPlanSegmentLevelDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningPlanSegmentLevelDTO: + """Test PlanningPlanSegmentLevelDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningPlanSegmentLevelDTO` + """ + model = PlanningPlanSegmentLevelDTO() + if include_optional: + return PlanningPlanSegmentLevelDTO( + id = '', + display_name = '', + order = 56, + segment_id = '', + segment_display_name = '' + ) + else: + return PlanningPlanSegmentLevelDTO( + ) + """ + + def testPlanningPlanSegmentLevelDTO(self): + """Test PlanningPlanSegmentLevelDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_plan_segment_level_member_dto.py b/src/visier_platform_sdk/test/test_planning_plan_segment_level_member_dto.py new file mode 100644 index 0000000000..a0fe65f3ed --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_plan_segment_level_member_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_plan_segment_level_member_dto import PlanningPlanSegmentLevelMemberDTO + +class TestPlanningPlanSegmentLevelMemberDTO(unittest.TestCase): + """PlanningPlanSegmentLevelMemberDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningPlanSegmentLevelMemberDTO: + """Test PlanningPlanSegmentLevelMemberDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningPlanSegmentLevelMemberDTO` + """ + model = PlanningPlanSegmentLevelMemberDTO() + if include_optional: + return PlanningPlanSegmentLevelMemberDTO( + id = '', + display_name = '', + is_custom = True, + parent_id = '' + ) + else: + return PlanningPlanSegmentLevelMemberDTO( + ) + """ + + def testPlanningPlanSegmentLevelMemberDTO(self): + """Test PlanningPlanSegmentLevelMemberDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_plan_segment_level_member_list_dto.py b/src/visier_platform_sdk/test/test_planning_plan_segment_level_member_list_dto.py new file mode 100644 index 0000000000..c4d99ca89a --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_plan_segment_level_member_list_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_plan_segment_level_member_list_dto import PlanningPlanSegmentLevelMemberListDTO + +class TestPlanningPlanSegmentLevelMemberListDTO(unittest.TestCase): + """PlanningPlanSegmentLevelMemberListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningPlanSegmentLevelMemberListDTO: + """Test PlanningPlanSegmentLevelMemberListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningPlanSegmentLevelMemberListDTO` + """ + model = PlanningPlanSegmentLevelMemberListDTO() + if include_optional: + return PlanningPlanSegmentLevelMemberListDTO( + segment_level_id = '', + members = [ + visier_platform_sdk.models.planning/plan_segment_level_member_dto.planning.PlanSegmentLevelMemberDTO( + id = '', + display_name = '', + is_custom = True, + parent_id = '', ) + ], + segment_id = '' + ) + else: + return PlanningPlanSegmentLevelMemberListDTO( + ) + """ + + def testPlanningPlanSegmentLevelMemberListDTO(self): + """Test PlanningPlanSegmentLevelMemberListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_plan_time_period_dto.py b/src/visier_platform_sdk/test/test_planning_plan_time_period_dto.py new file mode 100644 index 0000000000..8d78945bc2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_plan_time_period_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_plan_time_period_dto import PlanningPlanTimePeriodDTO + +class TestPlanningPlanTimePeriodDTO(unittest.TestCase): + """PlanningPlanTimePeriodDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningPlanTimePeriodDTO: + """Test PlanningPlanTimePeriodDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningPlanTimePeriodDTO` + """ + model = PlanningPlanTimePeriodDTO() + if include_optional: + return PlanningPlanTimePeriodDTO( + var_date = '', + display_name = '' + ) + else: + return PlanningPlanTimePeriodDTO( + ) + """ + + def testPlanningPlanTimePeriodDTO(self): + """Test PlanningPlanTimePeriodDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_plan_with_schema_dto.py b/src/visier_platform_sdk/test/test_planning_plan_with_schema_dto.py new file mode 100644 index 0000000000..b199aab03d --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_plan_with_schema_dto.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_plan_with_schema_dto import PlanningPlanWithSchemaDTO + +class TestPlanningPlanWithSchemaDTO(unittest.TestCase): + """PlanningPlanWithSchemaDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningPlanWithSchemaDTO: + """Test PlanningPlanWithSchemaDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningPlanWithSchemaDTO` + """ + model = PlanningPlanWithSchemaDTO() + if include_optional: + return PlanningPlanWithSchemaDTO( + plan = visier_platform_sdk.models.planning/plan_info_dto.planning.PlanInfoDTO( + uuid = '', + display_name = '', + model_id = '', + scenarios = [ + visier_platform_sdk.models.planning/scenario_info_dto.planning.ScenarioInfoDTO( + uuid = '', + display_name = '', + versioned_scenario_id = '', ) + ], + parent_plan_uuid = '', + currency_code = '', ), + var_schema = visier_platform_sdk.models.planning/plan_schema_dto.planning.PlanSchemaDTO( + plan_items = [ + visier_platform_sdk.models.planning/plan_item_dto.planning.PlanItemDTO( + id = '', + display_name = '', + data_type = 'unknown', ) + ], + time_periods = [ + visier_platform_sdk.models.planning/plan_time_period_dto.planning.PlanTimePeriodDTO( + date = '', + display_name = '', ) + ], + plan_segment_levels = [ + visier_platform_sdk.models.planning/plan_segment_level_dto.planning.PlanSegmentLevelDTO( + id = '', + display_name = '', + order = 56, + segment_id = '', + segment_display_name = '', ) + ], + plan_segment_level_members = [ + visier_platform_sdk.models.planning/plan_segment_level_member_list_dto.planning.PlanSegmentLevelMemberListDTO( + segment_level_id = '', + members = [ + visier_platform_sdk.models.planning/plan_segment_level_member_dto.planning.PlanSegmentLevelMemberDTO( + id = '', + display_name = '', + is_custom = True, + parent_id = '', ) + ], + segment_id = '', ) + ], ), + errors = [ + visier_platform_sdk.models.planning/plan_data_load_error_dto.planning.PlanDataLoadErrorDTO( + row = 56, + rci = '', + error_message = '', ) + ] + ) + else: + return PlanningPlanWithSchemaDTO( + ) + """ + + def testPlanningPlanWithSchemaDTO(self): + """Test PlanningPlanWithSchemaDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_planning_scenario_info_dto.py b/src/visier_platform_sdk/test/test_planning_scenario_info_dto.py new file mode 100644 index 0000000000..e9ad5b9440 --- /dev/null +++ b/src/visier_platform_sdk/test/test_planning_scenario_info_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.planning_scenario_info_dto import PlanningScenarioInfoDTO + +class TestPlanningScenarioInfoDTO(unittest.TestCase): + """PlanningScenarioInfoDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PlanningScenarioInfoDTO: + """Test PlanningScenarioInfoDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PlanningScenarioInfoDTO` + """ + model = PlanningScenarioInfoDTO() + if include_optional: + return PlanningScenarioInfoDTO( + uuid = '', + display_name = '', + versioned_scenario_id = '' + ) + else: + return PlanningScenarioInfoDTO( + ) + """ + + def testPlanningScenarioInfoDTO(self): + """Test PlanningScenarioInfoDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_production_versions_api.py b/src/visier_platform_sdk/test/test_production_versions_api.py new file mode 100644 index 0000000000..fbef8e2c51 --- /dev/null +++ b/src/visier_platform_sdk/test/test_production_versions_api.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.production_versions_api import ProductionVersionsApi + + +class TestProductionVersionsApi(unittest.TestCase): + """ProductionVersionsApi unit test stubs""" + + def setUp(self) -> None: + self.api = ProductionVersionsApi() + + def tearDown(self) -> None: + pass + + def test_get_production_versions(self) -> None: + """Test case for get_production_versions + + Retrieve a list of all production versions + """ + pass + + def test_post_production_version(self) -> None: + """Test case for post_production_version + + Perform an operation on a production version + """ + pass + + def test_post_production_versions(self) -> None: + """Test case for post_production_versions + + Perform an operation on production versions + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_profiles_api.py b/src/visier_platform_sdk/test/test_profiles_api.py new file mode 100644 index 0000000000..0a7f0ee665 --- /dev/null +++ b/src/visier_platform_sdk/test/test_profiles_api.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.profiles_api import ProfilesApi + + +class TestProfilesApi(unittest.TestCase): + """ProfilesApi unit test stubs""" + + def setUp(self) -> None: + self.api = ProfilesApi() + + def tearDown(self) -> None: + pass + + def test_assign_analytic_profile(self) -> None: + """Test case for assign_analytic_profile + + Assign an analytic tenant profile to administrating tenant users + """ + pass + + def test_assign_profile(self) -> None: + """Test case for assign_profile + + Assign a profile to a list of users + """ + pass + + def test_get_all_profiles(self) -> None: + """Test case for get_all_profiles + + Retrieve a list of all profiles + """ + pass + + def test_get_analytic_profile_detail(self) -> None: + """Test case for get_analytic_profile_detail + + Retrieve the details of an analytic tenant profile + """ + pass + + def test_get_analytic_profiles(self) -> None: + """Test case for get_analytic_profiles + + Retrieve a list of analytic tenant profiles + """ + pass + + def test_get_analytic_user_profile(self) -> None: + """Test case for get_analytic_user_profile + + Retrieve an administrating tenant user's analytic tenant profiles + """ + pass + + def test_get_profile_detail(self) -> None: + """Test case for get_profile_detail + + Retrieve the details of a profile + """ + pass + + def test_get_user_profile(self) -> None: + """Test case for get_user_profile + + Retrieve a user's profiles + """ + pass + + def test_remove_analytic_profile(self) -> None: + """Test case for remove_analytic_profile + + Remove an analytic tenant profile from administrating tenant users + """ + pass + + def test_remove_profile(self) -> None: + """Test case for remove_profile + + Remove a profile from a list of users + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_projects_api.py b/src/visier_platform_sdk/test/test_projects_api.py new file mode 100644 index 0000000000..0168cf361f --- /dev/null +++ b/src/visier_platform_sdk/test/test_projects_api.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.projects_api import ProjectsApi + + +class TestProjectsApi(unittest.TestCase): + """ProjectsApi unit test stubs""" + + def setUp(self) -> None: + self.api = ProjectsApi() + + def tearDown(self) -> None: + pass + + def test_create_project(self) -> None: + """Test case for create_project + + Create a new draft project + """ + pass + + def test_delete_project(self) -> None: + """Test case for delete_project + + Delete a draft project + """ + pass + + def test_get_project(self) -> None: + """Test case for get_project + + Retrieve a draft project's information + """ + pass + + def test_get_project_commits(self) -> None: + """Test case for get_project_commits + + Retrieve a list of all committed changes in a project + """ + pass + + def test_get_projects(self) -> None: + """Test case for get_projects + + Retrieve a list of draft projects accessible to the user + """ + pass + + def test_put_project_commits(self) -> None: + """Test case for put_project_commits + + Import committed changes into a project + """ + pass + + def test_run_project_operation(self) -> None: + """Test case for run_project_operation + + Perform an operation on a draft project + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_release_version_configuration_api.py b/src/visier_platform_sdk/test/test_release_version_configuration_api.py new file mode 100644 index 0000000000..7bb5ec1f72 --- /dev/null +++ b/src/visier_platform_sdk/test/test_release_version_configuration_api.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.release_version_configuration_api import ReleaseVersionConfigurationApi + + +class TestReleaseVersionConfigurationApi(unittest.TestCase): + """ReleaseVersionConfigurationApi unit test stubs""" + + def setUp(self) -> None: + self.api = ReleaseVersionConfigurationApi() + + def tearDown(self) -> None: + pass + + def test_get_available_releases(self) -> None: + """Test case for get_available_releases + + Retrieve available product releases + """ + pass + + def test_get_release_versions(self) -> None: + """Test case for get_release_versions + + Retrieve active product release versions + """ + pass + + def test_set_release_versions(self) -> None: + """Test case for set_release_versions + + Activate product release versions + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_reporting_api.py b/src/visier_platform_sdk/test/test_reporting_api.py new file mode 100644 index 0000000000..b53c326905 --- /dev/null +++ b/src/visier_platform_sdk/test/test_reporting_api.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.reporting_api import ReportingApi + + +class TestReportingApi(unittest.TestCase): + """ReportingApi unit test stubs""" + + def setUp(self) -> None: + self.api = ReportingApi() + + def tearDown(self) -> None: + pass + + def test_create_report(self) -> None: + """Test case for create_report + + Create a report + """ + pass + + def test_delete_report(self) -> None: + """Test case for delete_report + + Delete a report + """ + pass + + def test_download_report(self) -> None: + """Test case for download_report + + Download a report + """ + pass + + def test_duplicate_report(self) -> None: + """Test case for duplicate_report + + Duplicate a report + """ + pass + + def test_get_report(self) -> None: + """Test case for get_report + + Retrieve a report's details + """ + pass + + def test_get_reports(self) -> None: + """Test case for get_reports + + Retrieve a list of reports + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_salary_benchmark_input.py b/src/visier_platform_sdk/test/test_salary_benchmark_input.py new file mode 100644 index 0000000000..ac4169086c --- /dev/null +++ b/src/visier_platform_sdk/test/test_salary_benchmark_input.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.salary_benchmark_input import SalaryBenchmarkInput + +class TestSalaryBenchmarkInput(unittest.TestCase): + """SalaryBenchmarkInput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SalaryBenchmarkInput: + """Test SalaryBenchmarkInput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SalaryBenchmarkInput` + """ + model = SalaryBenchmarkInput() + if include_optional: + return SalaryBenchmarkInput( + uuid = '', + job = '', + industry = '', + naics_code = '', + location = '', + company_size = '', + career_level = '' + ) + else: + return SalaryBenchmarkInput( + uuid = '', + job = '', + ) + """ + + def testSalaryBenchmarkInput(self): + """Test SalaryBenchmarkInput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_salary_benchmarks_batch_processing_failure_output.py b/src/visier_platform_sdk/test/test_salary_benchmarks_batch_processing_failure_output.py new file mode 100644 index 0000000000..46ffca2d23 --- /dev/null +++ b/src/visier_platform_sdk/test/test_salary_benchmarks_batch_processing_failure_output.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.salary_benchmarks_batch_processing_failure_output import SalaryBenchmarksBatchProcessingFailureOutput + +class TestSalaryBenchmarksBatchProcessingFailureOutput(unittest.TestCase): + """SalaryBenchmarksBatchProcessingFailureOutput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SalaryBenchmarksBatchProcessingFailureOutput: + """Test SalaryBenchmarksBatchProcessingFailureOutput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SalaryBenchmarksBatchProcessingFailureOutput` + """ + model = SalaryBenchmarksBatchProcessingFailureOutput() + if include_optional: + return SalaryBenchmarksBatchProcessingFailureOutput( + uuid = '', + http_status = '', + message = '', + rci = '', + error_code = '' + ) + else: + return SalaryBenchmarksBatchProcessingFailureOutput( + uuid = '', + http_status = '', + message = '', + rci = '', + error_code = '', + ) + """ + + def testSalaryBenchmarksBatchProcessingFailureOutput(self): + """Test SalaryBenchmarksBatchProcessingFailureOutput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_salary_benchmarks_batch_processing_outputs.py b/src/visier_platform_sdk/test/test_salary_benchmarks_batch_processing_outputs.py new file mode 100644 index 0000000000..398204c198 --- /dev/null +++ b/src/visier_platform_sdk/test/test_salary_benchmarks_batch_processing_outputs.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.salary_benchmarks_batch_processing_outputs import SalaryBenchmarksBatchProcessingOutputs + +class TestSalaryBenchmarksBatchProcessingOutputs(unittest.TestCase): + """SalaryBenchmarksBatchProcessingOutputs unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SalaryBenchmarksBatchProcessingOutputs: + """Test SalaryBenchmarksBatchProcessingOutputs + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SalaryBenchmarksBatchProcessingOutputs` + """ + model = SalaryBenchmarksBatchProcessingOutputs() + if include_optional: + return SalaryBenchmarksBatchProcessingOutputs( + successes = [ + visier_platform_sdk.models.salary_benchmarks_batch_processing_successful_output.SalaryBenchmarksBatchProcessingSuccessfulOutput( + uuid = '', + percentile10 = 56, + percentile25 = 56, + percentile50 = 56, + percentile75 = 56, + percentile90 = 56, + aligned_range_min = 56, + aligned_range_max = 56, + reference_date = '', + release_date = '', + industry_id = '', + career_level_id = '', ) + ], + failures = [ + visier_platform_sdk.models.salary_benchmarks_batch_processing_failure_output.SalaryBenchmarksBatchProcessingFailureOutput( + uuid = '', + http_status = '', + message = '', + rci = '', + error_code = '', ) + ] + ) + else: + return SalaryBenchmarksBatchProcessingOutputs( + ) + """ + + def testSalaryBenchmarksBatchProcessingOutputs(self): + """Test SalaryBenchmarksBatchProcessingOutputs""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_salary_benchmarks_batch_processing_successful_output.py b/src/visier_platform_sdk/test/test_salary_benchmarks_batch_processing_successful_output.py new file mode 100644 index 0000000000..dc2cb02e7f --- /dev/null +++ b/src/visier_platform_sdk/test/test_salary_benchmarks_batch_processing_successful_output.py @@ -0,0 +1,75 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.salary_benchmarks_batch_processing_successful_output import SalaryBenchmarksBatchProcessingSuccessfulOutput + +class TestSalaryBenchmarksBatchProcessingSuccessfulOutput(unittest.TestCase): + """SalaryBenchmarksBatchProcessingSuccessfulOutput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SalaryBenchmarksBatchProcessingSuccessfulOutput: + """Test SalaryBenchmarksBatchProcessingSuccessfulOutput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SalaryBenchmarksBatchProcessingSuccessfulOutput` + """ + model = SalaryBenchmarksBatchProcessingSuccessfulOutput() + if include_optional: + return SalaryBenchmarksBatchProcessingSuccessfulOutput( + uuid = '', + percentile10 = 56, + percentile25 = 56, + percentile50 = 56, + percentile75 = 56, + percentile90 = 56, + aligned_range_min = 56, + aligned_range_max = 56, + reference_date = '', + release_date = '', + industry_id = '', + career_level_id = '' + ) + else: + return SalaryBenchmarksBatchProcessingSuccessfulOutput( + uuid = '', + percentile10 = 56, + percentile25 = 56, + percentile50 = 56, + percentile75 = 56, + percentile90 = 56, + aligned_range_min = 56, + aligned_range_max = 56, + reference_date = '', + release_date = '', + industry_id = '', + career_level_id = '', + ) + """ + + def testSalaryBenchmarksBatchProcessingSuccessfulOutput(self): + """Test SalaryBenchmarksBatchProcessingSuccessfulOutput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_search_api.py b/src/visier_platform_sdk/test/test_search_api.py new file mode 100644 index 0000000000..6ea446ac24 --- /dev/null +++ b/src/visier_platform_sdk/test/test_search_api.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.search_api import SearchApi + + +class TestSearchApi(unittest.TestCase): + """SearchApi unit test stubs""" + + def setUp(self) -> None: + self.api = SearchApi() + + def tearDown(self) -> None: + pass + + def test_simple_search_document_headers(self) -> None: + """Test case for simple_search_document_headers + + Perform a simple search for Visier document headers + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_assignment_request_dto.py b/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_assignment_request_dto.py new file mode 100644 index 0000000000..fced3f4d79 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_assignment_request_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_accessible_tenant_profile_assignment_request_dto import ServicingAccessibleTenantProfileAssignmentRequestDTO + +class TestServicingAccessibleTenantProfileAssignmentRequestDTO(unittest.TestCase): + """ServicingAccessibleTenantProfileAssignmentRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAccessibleTenantProfileAssignmentRequestDTO: + """Test ServicingAccessibleTenantProfileAssignmentRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAccessibleTenantProfileAssignmentRequestDTO` + """ + model = ServicingAccessibleTenantProfileAssignmentRequestDTO() + if include_optional: + return ServicingAccessibleTenantProfileAssignmentRequestDTO( + target_user_ids = [ + '' + ], + target_tenant_codes = [ + visier_platform_sdk.models.servicing/target_tenant_code_dto.servicing.TargetTenantCodeDTO( + tenant_code = '', + for_all_children = True, ) + ], + validity_start_time = '', + validity_end_time = '' + ) + else: + return ServicingAccessibleTenantProfileAssignmentRequestDTO( + ) + """ + + def testServicingAccessibleTenantProfileAssignmentRequestDTO(self): + """Test ServicingAccessibleTenantProfileAssignmentRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_assignment_response_dto.py b/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_assignment_response_dto.py new file mode 100644 index 0000000000..c15503d445 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_assignment_response_dto.py @@ -0,0 +1,76 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_accessible_tenant_profile_assignment_response_dto import ServicingAccessibleTenantProfileAssignmentResponseDTO + +class TestServicingAccessibleTenantProfileAssignmentResponseDTO(unittest.TestCase): + """ServicingAccessibleTenantProfileAssignmentResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAccessibleTenantProfileAssignmentResponseDTO: + """Test ServicingAccessibleTenantProfileAssignmentResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAccessibleTenantProfileAssignmentResponseDTO` + """ + model = ServicingAccessibleTenantProfileAssignmentResponseDTO() + if include_optional: + return ServicingAccessibleTenantProfileAssignmentResponseDTO( + errors = True, + bad_tenant_codes = [ + visier_platform_sdk.models.servicing/tenant_code_error_dto.servicing.TenantCodeErrorDTO( + tenant_code = '', + for_all_children = True, + error = None, ) + ], + bad_user_ids = [ + visier_platform_sdk.models.servicing/user_id_error_dto.servicing.UserIdErrorDTO( + user_id = '', + error = None, ) + ], + failed_assignments = [ + visier_platform_sdk.models.servicing/failed_accessible_tenant_profile_assignment_dto.servicing.FailedAccessibleTenantProfileAssignmentDTO( + user_id = '', + tenant_code = '', + for_all_children = True, + error = None, ) + ], + successful_assignments = [ + visier_platform_sdk.models.servicing/successful_accessible_tenant_profile_assignment_dto.servicing.SuccessfulAccessibleTenantProfileAssignmentDTO( + user_id = '', + tenant_code = '', + for_all_children = True, ) + ] + ) + else: + return ServicingAccessibleTenantProfileAssignmentResponseDTO( + ) + """ + + def testServicingAccessibleTenantProfileAssignmentResponseDTO(self): + """Test ServicingAccessibleTenantProfileAssignmentResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_revoke_request_dto.py b/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_revoke_request_dto.py new file mode 100644 index 0000000000..0338d6271b --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_revoke_request_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_accessible_tenant_profile_revoke_request_dto import ServicingAccessibleTenantProfileRevokeRequestDTO + +class TestServicingAccessibleTenantProfileRevokeRequestDTO(unittest.TestCase): + """ServicingAccessibleTenantProfileRevokeRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAccessibleTenantProfileRevokeRequestDTO: + """Test ServicingAccessibleTenantProfileRevokeRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAccessibleTenantProfileRevokeRequestDTO` + """ + model = ServicingAccessibleTenantProfileRevokeRequestDTO() + if include_optional: + return ServicingAccessibleTenantProfileRevokeRequestDTO( + target_user_ids = [ + '' + ], + target_tenant_codes = [ + visier_platform_sdk.models.servicing/target_tenant_code_dto.servicing.TargetTenantCodeDTO( + tenant_code = '', + for_all_children = True, ) + ] + ) + else: + return ServicingAccessibleTenantProfileRevokeRequestDTO( + ) + """ + + def testServicingAccessibleTenantProfileRevokeRequestDTO(self): + """Test ServicingAccessibleTenantProfileRevokeRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_revoke_response_dto.py b/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_revoke_response_dto.py new file mode 100644 index 0000000000..01bd34904f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_accessible_tenant_profile_revoke_response_dto.py @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_accessible_tenant_profile_revoke_response_dto import ServicingAccessibleTenantProfileRevokeResponseDTO + +class TestServicingAccessibleTenantProfileRevokeResponseDTO(unittest.TestCase): + """ServicingAccessibleTenantProfileRevokeResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAccessibleTenantProfileRevokeResponseDTO: + """Test ServicingAccessibleTenantProfileRevokeResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAccessibleTenantProfileRevokeResponseDTO` + """ + model = ServicingAccessibleTenantProfileRevokeResponseDTO() + if include_optional: + return ServicingAccessibleTenantProfileRevokeResponseDTO( + bad_tenant_codes = [ + visier_platform_sdk.models.servicing/reduced_tenant_code_error_dto.servicing.ReducedTenantCodeErrorDTO( + tenant_code = '', + for_all_children = True, + error = None, ) + ], + bad_user_ids = [ + visier_platform_sdk.models.servicing/reduced_user_id_error_dto.servicing.ReducedUserIdErrorDTO( + user_id = '', + error = None, ) + ], + unaffected_users = [ + visier_platform_sdk.models.servicing/successful_local_tenant_profile_assignment_dto.servicing.SuccessfulLocalTenantProfileAssignmentDTO( + user_id = '', ) + ], + succeeded = [ + visier_platform_sdk.models.servicing/successful_local_tenant_profile_assignment_dto.servicing.SuccessfulLocalTenantProfileAssignmentDTO( + user_id = '', ) + ] + ) + else: + return ServicingAccessibleTenantProfileRevokeResponseDTO( + ) + """ + + def testServicingAccessibleTenantProfileRevokeResponseDTO(self): + """Test ServicingAccessibleTenantProfileRevokeResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_additional_capabilities_dto.py b/src/visier_platform_sdk/test/test_servicing_additional_capabilities_dto.py new file mode 100644 index 0000000000..83d079ed26 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_additional_capabilities_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_additional_capabilities_dto import ServicingAdditionalCapabilitiesDTO + +class TestServicingAdditionalCapabilitiesDTO(unittest.TestCase): + """ServicingAdditionalCapabilitiesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAdditionalCapabilitiesDTO: + """Test ServicingAdditionalCapabilitiesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAdditionalCapabilitiesDTO` + """ + model = ServicingAdditionalCapabilitiesDTO() + if include_optional: + return ServicingAdditionalCapabilitiesDTO( + additional_capabilities = [ + '' + ] + ) + else: + return ServicingAdditionalCapabilitiesDTO( + ) + """ + + def testServicingAdditionalCapabilitiesDTO(self): + """Test ServicingAdditionalCapabilitiesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_admin_capability_config_dto.py b/src/visier_platform_sdk/test/test_servicing_admin_capability_config_dto.py new file mode 100644 index 0000000000..ed96e8a1f9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_admin_capability_config_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_admin_capability_config_dto import ServicingAdminCapabilityConfigDTO + +class TestServicingAdminCapabilityConfigDTO(unittest.TestCase): + """ServicingAdminCapabilityConfigDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAdminCapabilityConfigDTO: + """Test ServicingAdminCapabilityConfigDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAdminCapabilityConfigDTO` + """ + model = ServicingAdminCapabilityConfigDTO() + if include_optional: + return ServicingAdminCapabilityConfigDTO( + all_capabilities_access = True, + capabilities = [ + '' + ] + ) + else: + return ServicingAdminCapabilityConfigDTO( + ) + """ + + def testServicingAdminCapabilityConfigDTO(self): + """Test ServicingAdminCapabilityConfigDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_all_permissions_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_all_permissions_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..30e82f54e4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_all_permissions_assigned_for_local_tenant_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_all_permissions_assigned_for_local_tenant_dto import ServicingAllPermissionsAssignedForLocalTenantDTO + +class TestServicingAllPermissionsAssignedForLocalTenantDTO(unittest.TestCase): + """ServicingAllPermissionsAssignedForLocalTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAllPermissionsAssignedForLocalTenantDTO: + """Test ServicingAllPermissionsAssignedForLocalTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAllPermissionsAssignedForLocalTenantDTO` + """ + model = ServicingAllPermissionsAssignedForLocalTenantDTO() + if include_optional: + return ServicingAllPermissionsAssignedForLocalTenantDTO( + assigned_permissions = [ + visier_platform_sdk.models.servicing/permission_assigned_for_local_tenant_dto.servicing.PermissionAssignedForLocalTenantDTO( + permission_id = '', + display_name = '', + description = '', ) + ] + ) + else: + return ServicingAllPermissionsAssignedForLocalTenantDTO( + ) + """ + + def testServicingAllPermissionsAssignedForLocalTenantDTO(self): + """Test ServicingAllPermissionsAssignedForLocalTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_all_profile_assigned_for_accessible_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_all_profile_assigned_for_accessible_tenant_dto.py new file mode 100644 index 0000000000..1f86c50477 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_all_profile_assigned_for_accessible_tenant_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_all_profile_assigned_for_accessible_tenant_dto import ServicingAllProfileAssignedForAccessibleTenantDTO + +class TestServicingAllProfileAssignedForAccessibleTenantDTO(unittest.TestCase): + """ServicingAllProfileAssignedForAccessibleTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAllProfileAssignedForAccessibleTenantDTO: + """Test ServicingAllProfileAssignedForAccessibleTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAllProfileAssignedForAccessibleTenantDTO` + """ + model = ServicingAllProfileAssignedForAccessibleTenantDTO() + if include_optional: + return ServicingAllProfileAssignedForAccessibleTenantDTO( + assigned_profiles_for_accessible_tenant = [ + visier_platform_sdk.models.servicing/profile_assigned_for_accessible_tenant_dto.servicing.ProfileAssignedForAccessibleTenantDTO( + profile_id = '', + display_name = '', + tenant_code = '', + for_all_children = True, + validity_start_time = '', + validity_end_time = '', ) + ] + ) + else: + return ServicingAllProfileAssignedForAccessibleTenantDTO( + ) + """ + + def testServicingAllProfileAssignedForAccessibleTenantDTO(self): + """Test ServicingAllProfileAssignedForAccessibleTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_all_profile_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_all_profile_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..3e72f042b7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_all_profile_assigned_for_local_tenant_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_all_profile_assigned_for_local_tenant_dto import ServicingAllProfileAssignedForLocalTenantDTO + +class TestServicingAllProfileAssignedForLocalTenantDTO(unittest.TestCase): + """ServicingAllProfileAssignedForLocalTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAllProfileAssignedForLocalTenantDTO: + """Test ServicingAllProfileAssignedForLocalTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAllProfileAssignedForLocalTenantDTO` + """ + model = ServicingAllProfileAssignedForLocalTenantDTO() + if include_optional: + return ServicingAllProfileAssignedForLocalTenantDTO( + assigned_profiles = [ + visier_platform_sdk.models.servicing/profile_assigned_for_local_tenant_dto.servicing.ProfileAssignedForLocalTenantDTO( + profile_id = '', + display_name = '', + validity_start_time = '', + validity_end_time = '', + capabilities = [ + visier_platform_sdk.models.servicing/capabilities_dto.servicing.CapabilitiesDTO( + capability = '', + access_level = '', + view_level = '', ) + ], + additional_capabilities = None, ) + ] + ) + else: + return ServicingAllProfileAssignedForLocalTenantDTO( + ) + """ + + def testServicingAllProfileAssignedForLocalTenantDTO(self): + """Test ServicingAllProfileAssignedForLocalTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_all_user_groups_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_all_user_groups_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..e19996d764 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_all_user_groups_assigned_for_local_tenant_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_all_user_groups_assigned_for_local_tenant_dto import ServicingAllUserGroupsAssignedForLocalTenantDTO + +class TestServicingAllUserGroupsAssignedForLocalTenantDTO(unittest.TestCase): + """ServicingAllUserGroupsAssignedForLocalTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAllUserGroupsAssignedForLocalTenantDTO: + """Test ServicingAllUserGroupsAssignedForLocalTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAllUserGroupsAssignedForLocalTenantDTO` + """ + model = ServicingAllUserGroupsAssignedForLocalTenantDTO() + if include_optional: + return ServicingAllUserGroupsAssignedForLocalTenantDTO( + assigned_user_groups = [ + visier_platform_sdk.models.servicing/user_group_assigned_for_local_tenant_dto.servicing.UserGroupAssignedForLocalTenantDTO( + user_group_id = '', + display_name = '', ) + ] + ) + else: + return ServicingAllUserGroupsAssignedForLocalTenantDTO( + ) + """ + + def testServicingAllUserGroupsAssignedForLocalTenantDTO(self): + """Test ServicingAllUserGroupsAssignedForLocalTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_all_users_get_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_all_users_get_api_response_dto.py new file mode 100644 index 0000000000..e7089c3280 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_all_users_get_api_response_dto.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_all_users_get_api_response_dto import ServicingAllUsersGetAPIResponseDTO + +class TestServicingAllUsersGetAPIResponseDTO(unittest.TestCase): + """ServicingAllUsersGetAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAllUsersGetAPIResponseDTO: + """Test ServicingAllUsersGetAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAllUsersGetAPIResponseDTO` + """ + model = ServicingAllUsersGetAPIResponseDTO() + if include_optional: + return ServicingAllUsersGetAPIResponseDTO( + users = [ + visier_platform_sdk.models.servicing/user_get_api_response_dto.servicing.UserGetAPIResponseDTO( + user_id = '', + username = '', + display_name = '', + employee_id = '', + account_enabled = True, + profiles = None, + permissions = None, + user_groups = None, + last_login = None, + email = '', ) + ], + limit = 56, + start = 56 + ) + else: + return ServicingAllUsersGetAPIResponseDTO( + ) + """ + + def testServicingAllUsersGetAPIResponseDTO(self): + """Test ServicingAllUsersGetAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_analytic_object_dto.py b/src/visier_platform_sdk/test/test_servicing_analytic_object_dto.py new file mode 100644 index 0000000000..7c0eb545a9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_analytic_object_dto.py @@ -0,0 +1,80 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_analytic_object_dto import ServicingAnalyticObjectDTO + +class TestServicingAnalyticObjectDTO(unittest.TestCase): + """ServicingAnalyticObjectDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAnalyticObjectDTO: + """Test ServicingAnalyticObjectDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAnalyticObjectDTO` + """ + model = ServicingAnalyticObjectDTO() + if include_optional: + return ServicingAnalyticObjectDTO( + analytic_object_id = '', + display_name = '', + object_type = 'Event', + related_objects = [ + visier_platform_sdk.models.servicing/related_analytic_object_dto.servicing.RelatedAnalyticObjectDTO( + analytic_object_id = '', + display_name = '', ) + ], + securable_properties = [ + visier_platform_sdk.models.servicing/securable_property_dto.servicing.SecurablePropertyDTO( + property_id = '', + display_name = '', + analytic_object_id = '', + is_primary_key = True, + reference_symbol_name = '', ) + ], + securable_dimensions = [ + visier_platform_sdk.models.servicing/securable_dimension_dto.servicing.SecurableDimensionDTO( + dimension_id = '', + display_name = '', + analytic_object_ids = [ + '' + ], + hierarchy_properties = [ + visier_platform_sdk.models.servicing/hierarchy_property_dto.servicing.HierarchyPropertyDTO( + hierarchy_property_id = '', + display_name = '', ) + ], ) + ] + ) + else: + return ServicingAnalyticObjectDTO( + ) + """ + + def testServicingAnalyticObjectDTO(self): + """Test ServicingAnalyticObjectDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_by_permission_dto.py b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_by_permission_dto.py new file mode 100644 index 0000000000..0b4ec23ba5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_by_permission_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_permission_dto import ServicingAssignRevokePermissionByPermissionDTO + +class TestServicingAssignRevokePermissionByPermissionDTO(unittest.TestCase): + """ServicingAssignRevokePermissionByPermissionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAssignRevokePermissionByPermissionDTO: + """Test ServicingAssignRevokePermissionByPermissionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAssignRevokePermissionByPermissionDTO` + """ + model = ServicingAssignRevokePermissionByPermissionDTO() + if include_optional: + return ServicingAssignRevokePermissionByPermissionDTO( + permission = visier_platform_sdk.models.servicing/permission_assigned_for_local_tenant_dto.servicing.PermissionAssignedForLocalTenantDTO( + permission_id = '', + display_name = '', + description = '', ), + users = [ + visier_platform_sdk.models.servicing/assign_revoke_permission_by_user_dto.servicing.AssignRevokePermissionByUserDTO( + user_id = '', + username = '', + message = '', ) + ] + ) + else: + return ServicingAssignRevokePermissionByPermissionDTO( + ) + """ + + def testServicingAssignRevokePermissionByPermissionDTO(self): + """Test ServicingAssignRevokePermissionByPermissionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_by_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_by_tenant_dto.py new file mode 100644 index 0000000000..e6d51c30d1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_by_tenant_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_tenant_dto import ServicingAssignRevokePermissionByTenantDTO + +class TestServicingAssignRevokePermissionByTenantDTO(unittest.TestCase): + """ServicingAssignRevokePermissionByTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAssignRevokePermissionByTenantDTO: + """Test ServicingAssignRevokePermissionByTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAssignRevokePermissionByTenantDTO` + """ + model = ServicingAssignRevokePermissionByTenantDTO() + if include_optional: + return ServicingAssignRevokePermissionByTenantDTO( + tenant_code = '', + permissions = [ + visier_platform_sdk.models.servicing/assign_revoke_permission_by_permission_dto.servicing.AssignRevokePermissionByPermissionDTO( + permission = visier_platform_sdk.models.servicing/permission_assigned_for_local_tenant_dto.servicing.PermissionAssignedForLocalTenantDTO( + permission_id = '', + display_name = '', + description = '', ), + users = [ + visier_platform_sdk.models.servicing/assign_revoke_permission_by_user_dto.servicing.AssignRevokePermissionByUserDTO( + user_id = '', + username = '', + message = '', ) + ], ) + ], + status = 'Unknown', + message = '', + project_id = '' + ) + else: + return ServicingAssignRevokePermissionByTenantDTO( + ) + """ + + def testServicingAssignRevokePermissionByTenantDTO(self): + """Test ServicingAssignRevokePermissionByTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_by_user_dto.py b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_by_user_dto.py new file mode 100644 index 0000000000..66da5879ee --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_by_user_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_user_dto import ServicingAssignRevokePermissionByUserDTO + +class TestServicingAssignRevokePermissionByUserDTO(unittest.TestCase): + """ServicingAssignRevokePermissionByUserDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAssignRevokePermissionByUserDTO: + """Test ServicingAssignRevokePermissionByUserDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAssignRevokePermissionByUserDTO` + """ + model = ServicingAssignRevokePermissionByUserDTO() + if include_optional: + return ServicingAssignRevokePermissionByUserDTO( + user_id = '', + username = '', + message = '' + ) + else: + return ServicingAssignRevokePermissionByUserDTO( + ) + """ + + def testServicingAssignRevokePermissionByUserDTO(self): + """Test ServicingAssignRevokePermissionByUserDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_request_dto.py b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_request_dto.py new file mode 100644 index 0000000000..1d28acbd97 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permission_request_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_assign_revoke_permission_request_dto import ServicingAssignRevokePermissionRequestDTO + +class TestServicingAssignRevokePermissionRequestDTO(unittest.TestCase): + """ServicingAssignRevokePermissionRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAssignRevokePermissionRequestDTO: + """Test ServicingAssignRevokePermissionRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAssignRevokePermissionRequestDTO` + """ + model = ServicingAssignRevokePermissionRequestDTO() + if include_optional: + return ServicingAssignRevokePermissionRequestDTO( + permission_id = '', + user_ids = [ + '' + ] + ) + else: + return ServicingAssignRevokePermissionRequestDTO( + ) + """ + + def testServicingAssignRevokePermissionRequestDTO(self): + """Test ServicingAssignRevokePermissionRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_assign_revoke_permissions_request_dto.py b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permissions_request_dto.py new file mode 100644 index 0000000000..5ac721c4a1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permissions_request_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_assign_revoke_permissions_request_dto import ServicingAssignRevokePermissionsRequestDTO + +class TestServicingAssignRevokePermissionsRequestDTO(unittest.TestCase): + """ServicingAssignRevokePermissionsRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAssignRevokePermissionsRequestDTO: + """Test ServicingAssignRevokePermissionsRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAssignRevokePermissionsRequestDTO` + """ + model = ServicingAssignRevokePermissionsRequestDTO() + if include_optional: + return ServicingAssignRevokePermissionsRequestDTO( + permissions = [ + visier_platform_sdk.models.servicing/assign_revoke_permission_request_dto.servicing.AssignRevokePermissionRequestDTO( + permission_id = '', + user_ids = [ + '' + ], ) + ], + target_project_for_tenants_list = visier_platform_sdk.models.admin/target_project_for_tenants_list_dto.admin.TargetProjectForTenantsListDTO( + target_project_for_tenants = [ + visier_platform_sdk.models.admin/target_project_for_tenant_dto.admin.TargetProjectForTenantDTO( + tenant_code = '', + project_id = '', ) + ], ) + ) + else: + return ServicingAssignRevokePermissionsRequestDTO( + ) + """ + + def testServicingAssignRevokePermissionsRequestDTO(self): + """Test ServicingAssignRevokePermissionsRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_assign_revoke_permissions_response_dto.py b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permissions_response_dto.py new file mode 100644 index 0000000000..273939c742 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_assign_revoke_permissions_response_dto.py @@ -0,0 +1,71 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_assign_revoke_permissions_response_dto import ServicingAssignRevokePermissionsResponseDTO + +class TestServicingAssignRevokePermissionsResponseDTO(unittest.TestCase): + """ServicingAssignRevokePermissionsResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingAssignRevokePermissionsResponseDTO: + """Test ServicingAssignRevokePermissionsResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingAssignRevokePermissionsResponseDTO` + """ + model = ServicingAssignRevokePermissionsResponseDTO() + if include_optional: + return ServicingAssignRevokePermissionsResponseDTO( + tenants = [ + visier_platform_sdk.models.servicing/assign_revoke_permission_by_tenant_dto.servicing.AssignRevokePermissionByTenantDTO( + tenant_code = '', + permissions = [ + visier_platform_sdk.models.servicing/assign_revoke_permission_by_permission_dto.servicing.AssignRevokePermissionByPermissionDTO( + permission = visier_platform_sdk.models.servicing/permission_assigned_for_local_tenant_dto.servicing.PermissionAssignedForLocalTenantDTO( + permission_id = '', + display_name = '', + description = '', ), + users = [ + visier_platform_sdk.models.servicing/assign_revoke_permission_by_user_dto.servicing.AssignRevokePermissionByUserDTO( + user_id = '', + username = '', + message = '', ) + ], ) + ], + status = 'Unknown', + message = '', + project_id = '', ) + ] + ) + else: + return ServicingAssignRevokePermissionsResponseDTO( + ) + """ + + def testServicingAssignRevokePermissionsResponseDTO(self): + """Test ServicingAssignRevokePermissionsResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_bulk_data_access_set_response_dto.py b/src/visier_platform_sdk/test/test_servicing_bulk_data_access_set_response_dto.py new file mode 100644 index 0000000000..ad2b80db39 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_bulk_data_access_set_response_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_bulk_data_access_set_response_dto import ServicingBulkDataAccessSetResponseDTO + +class TestServicingBulkDataAccessSetResponseDTO(unittest.TestCase): + """ServicingBulkDataAccessSetResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingBulkDataAccessSetResponseDTO: + """Test ServicingBulkDataAccessSetResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingBulkDataAccessSetResponseDTO` + """ + model = ServicingBulkDataAccessSetResponseDTO() + if include_optional: + return ServicingBulkDataAccessSetResponseDTO( + successes = [ + visier_platform_sdk.models.servicing/data_access_set_success_dto.servicing.DataAccessSetSuccessDTO( + data_access_set_id = '', + display_name = '', ) + ], + failures = [ + visier_platform_sdk.models.servicing/data_access_set_failure_dto.servicing.DataAccessSetFailureDTO( + data_access_set_id = '', + display_name = '', + error = None, ) + ] + ) + else: + return ServicingBulkDataAccessSetResponseDTO( + ) + """ + + def testServicingBulkDataAccessSetResponseDTO(self): + """Test ServicingBulkDataAccessSetResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_capabilities_dto.py b/src/visier_platform_sdk/test/test_servicing_capabilities_dto.py new file mode 100644 index 0000000000..f444d8b33a --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_capabilities_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_capabilities_dto import ServicingCapabilitiesDTO + +class TestServicingCapabilitiesDTO(unittest.TestCase): + """ServicingCapabilitiesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingCapabilitiesDTO: + """Test ServicingCapabilitiesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingCapabilitiesDTO` + """ + model = ServicingCapabilitiesDTO() + if include_optional: + return ServicingCapabilitiesDTO( + capability = '', + access_level = '', + view_level = '' + ) + else: + return ServicingCapabilitiesDTO( + ) + """ + + def testServicingCapabilitiesDTO(self): + """Test ServicingCapabilitiesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_capability_dto.py b/src/visier_platform_sdk/test/test_servicing_capability_dto.py new file mode 100644 index 0000000000..7da9950a52 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_capability_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_capability_dto import ServicingCapabilityDTO + +class TestServicingCapabilityDTO(unittest.TestCase): + """ServicingCapabilityDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingCapabilityDTO: + """Test ServicingCapabilityDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingCapabilityDTO` + """ + model = ServicingCapabilityDTO() + if include_optional: + return ServicingCapabilityDTO( + name = '', + display_name = '', + description = '' + ) + else: + return ServicingCapabilityDTO( + ) + """ + + def testServicingCapabilityDTO(self): + """Test ServicingCapabilityDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_capability_group_dto.py b/src/visier_platform_sdk/test/test_servicing_capability_group_dto.py new file mode 100644 index 0000000000..c8bc72965f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_capability_group_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_capability_group_dto import ServicingCapabilityGroupDTO + +class TestServicingCapabilityGroupDTO(unittest.TestCase): + """ServicingCapabilityGroupDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingCapabilityGroupDTO: + """Test ServicingCapabilityGroupDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingCapabilityGroupDTO` + """ + model = ServicingCapabilityGroupDTO() + if include_optional: + return ServicingCapabilityGroupDTO( + group = 'unknown', + access_level = 'NoAccess', + view_level = 'Simple', + api_access_level = 'NoAccess', + api_view_level = 'Simple' + ) + else: + return ServicingCapabilityGroupDTO( + ) + """ + + def testServicingCapabilityGroupDTO(self): + """Test ServicingCapabilityGroupDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_commit_and_publish_operation_response_dto.py b/src/visier_platform_sdk/test/test_servicing_commit_and_publish_operation_response_dto.py new file mode 100644 index 0000000000..692f1dc623 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_commit_and_publish_operation_response_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_commit_and_publish_operation_response_dto import ServicingCommitAndPublishOperationResponseDTO + +class TestServicingCommitAndPublishOperationResponseDTO(unittest.TestCase): + """ServicingCommitAndPublishOperationResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingCommitAndPublishOperationResponseDTO: + """Test ServicingCommitAndPublishOperationResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingCommitAndPublishOperationResponseDTO` + """ + model = ServicingCommitAndPublishOperationResponseDTO() + if include_optional: + return ServicingCommitAndPublishOperationResponseDTO( + published_version = visier_platform_sdk.models.servicing/project_dto.servicing.ProjectDTO( + id = '', + name = '', + description = '', + release_version = '', + ticket_number = '', + version_number = 56, + capabilities = [ + 'canRead' + ], ) + ) + else: + return ServicingCommitAndPublishOperationResponseDTO( + ) + """ + + def testServicingCommitAndPublishOperationResponseDTO(self): + """Test ServicingCommitAndPublishOperationResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_commit_dto.py b/src/visier_platform_sdk/test/test_servicing_commit_dto.py new file mode 100644 index 0000000000..196c1583da --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_commit_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_commit_dto import ServicingCommitDTO + +class TestServicingCommitDTO(unittest.TestCase): + """ServicingCommitDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingCommitDTO: + """Test ServicingCommitDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingCommitDTO` + """ + model = ServicingCommitDTO() + if include_optional: + return ServicingCommitDTO( + id = '', + name = '', + description = '' + ) + else: + return ServicingCommitDTO( + ) + """ + + def testServicingCommitDTO(self): + """Test ServicingCommitDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_content_package_dto.py b/src/visier_platform_sdk/test/test_servicing_content_package_dto.py new file mode 100644 index 0000000000..08ab6ea521 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_content_package_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_content_package_dto import ServicingContentPackageDTO + +class TestServicingContentPackageDTO(unittest.TestCase): + """ServicingContentPackageDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingContentPackageDTO: + """Test ServicingContentPackageDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingContentPackageDTO` + """ + model = ServicingContentPackageDTO() + if include_optional: + return ServicingContentPackageDTO( + content_package_id = '', + display_name = '', + description = '' + ) + else: + return ServicingContentPackageDTO( + ) + """ + + def testServicingContentPackageDTO(self): + """Test ServicingContentPackageDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_create_data_access_set_request_dto.py b/src/visier_platform_sdk/test/test_servicing_create_data_access_set_request_dto.py new file mode 100644 index 0000000000..95ad966f14 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_create_data_access_set_request_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_create_data_access_set_request_dto import ServicingCreateDataAccessSetRequestDTO + +class TestServicingCreateDataAccessSetRequestDTO(unittest.TestCase): + """ServicingCreateDataAccessSetRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingCreateDataAccessSetRequestDTO: + """Test ServicingCreateDataAccessSetRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingCreateDataAccessSetRequestDTO` + """ + model = ServicingCreateDataAccessSetRequestDTO() + if include_optional: + return ServicingCreateDataAccessSetRequestDTO( + shareable_property_access_configs = [ + visier_platform_sdk.models.servicing/data_access_set_dto.servicing.DataAccessSetDTO( + id = '', + display_name = '', + description = '', + analytic_object_id = '', + property_access_configs = [ + visier_platform_sdk.models.servicing/property_access_config_dto.servicing.PropertyAccessConfigDTO( + property_id = '', + analytic_object_id = '', + analytic_object_reference_paths = [ + '' + ], + access_level = 'None', + property_status = 'Unset', ) + ], ) + ] + ) + else: + return ServicingCreateDataAccessSetRequestDTO( + ) + """ + + def testServicingCreateDataAccessSetRequestDTO(self): + """Test ServicingCreateDataAccessSetRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_data_access_set_dto.py b/src/visier_platform_sdk/test/test_servicing_data_access_set_dto.py new file mode 100644 index 0000000000..c8a42595b2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_data_access_set_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_data_access_set_dto import ServicingDataAccessSetDTO + +class TestServicingDataAccessSetDTO(unittest.TestCase): + """ServicingDataAccessSetDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDataAccessSetDTO: + """Test ServicingDataAccessSetDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDataAccessSetDTO` + """ + model = ServicingDataAccessSetDTO() + if include_optional: + return ServicingDataAccessSetDTO( + id = '', + display_name = '', + description = '', + analytic_object_id = '', + property_access_configs = [ + visier_platform_sdk.models.servicing/property_access_config_dto.servicing.PropertyAccessConfigDTO( + property_id = '', + analytic_object_id = '', + analytic_object_reference_paths = [ + '' + ], + access_level = 'None', + property_status = 'Unset', ) + ] + ) + else: + return ServicingDataAccessSetDTO( + ) + """ + + def testServicingDataAccessSetDTO(self): + """Test ServicingDataAccessSetDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_data_access_set_error_dto.py b/src/visier_platform_sdk/test/test_servicing_data_access_set_error_dto.py new file mode 100644 index 0000000000..32aebfbd63 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_data_access_set_error_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_data_access_set_error_dto import ServicingDataAccessSetErrorDTO + +class TestServicingDataAccessSetErrorDTO(unittest.TestCase): + """ServicingDataAccessSetErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDataAccessSetErrorDTO: + """Test ServicingDataAccessSetErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDataAccessSetErrorDTO` + """ + model = ServicingDataAccessSetErrorDTO() + if include_optional: + return ServicingDataAccessSetErrorDTO( + message = '', + rci = '' + ) + else: + return ServicingDataAccessSetErrorDTO( + ) + """ + + def testServicingDataAccessSetErrorDTO(self): + """Test ServicingDataAccessSetErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_data_access_set_failure_dto.py b/src/visier_platform_sdk/test/test_servicing_data_access_set_failure_dto.py new file mode 100644 index 0000000000..e0c7455476 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_data_access_set_failure_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_data_access_set_failure_dto import ServicingDataAccessSetFailureDTO + +class TestServicingDataAccessSetFailureDTO(unittest.TestCase): + """ServicingDataAccessSetFailureDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDataAccessSetFailureDTO: + """Test ServicingDataAccessSetFailureDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDataAccessSetFailureDTO` + """ + model = ServicingDataAccessSetFailureDTO() + if include_optional: + return ServicingDataAccessSetFailureDTO( + data_access_set_id = '', + display_name = '', + error = visier_platform_sdk.models.servicing/data_access_set_error_dto.servicing.DataAccessSetErrorDTO( + message = '', + rci = '', ) + ) + else: + return ServicingDataAccessSetFailureDTO( + ) + """ + + def testServicingDataAccessSetFailureDTO(self): + """Test ServicingDataAccessSetFailureDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_data_access_set_success_dto.py b/src/visier_platform_sdk/test/test_servicing_data_access_set_success_dto.py new file mode 100644 index 0000000000..42c41ff588 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_data_access_set_success_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_data_access_set_success_dto import ServicingDataAccessSetSuccessDTO + +class TestServicingDataAccessSetSuccessDTO(unittest.TestCase): + """ServicingDataAccessSetSuccessDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDataAccessSetSuccessDTO: + """Test ServicingDataAccessSetSuccessDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDataAccessSetSuccessDTO` + """ + model = ServicingDataAccessSetSuccessDTO() + if include_optional: + return ServicingDataAccessSetSuccessDTO( + data_access_set_id = '', + display_name = '' + ) + else: + return ServicingDataAccessSetSuccessDTO( + ) + """ + + def testServicingDataAccessSetSuccessDTO(self): + """Test ServicingDataAccessSetSuccessDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_data_categories_response_dto.py b/src/visier_platform_sdk/test/test_servicing_data_categories_response_dto.py new file mode 100644 index 0000000000..220d439d17 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_data_categories_response_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_data_categories_response_dto import ServicingDataCategoriesResponseDTO + +class TestServicingDataCategoriesResponseDTO(unittest.TestCase): + """ServicingDataCategoriesResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDataCategoriesResponseDTO: + """Test ServicingDataCategoriesResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDataCategoriesResponseDTO` + """ + model = ServicingDataCategoriesResponseDTO() + if include_optional: + return ServicingDataCategoriesResponseDTO( + categories = [ + visier_platform_sdk.models.servicing/data_category_response_dto.servicing.DataCategoryResponseDTO( + name = '', + id = '', ) + ] + ) + else: + return ServicingDataCategoriesResponseDTO( + ) + """ + + def testServicingDataCategoriesResponseDTO(self): + """Test ServicingDataCategoriesResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_data_category_response_dto.py b/src/visier_platform_sdk/test/test_servicing_data_category_response_dto.py new file mode 100644 index 0000000000..ea60874b27 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_data_category_response_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_data_category_response_dto import ServicingDataCategoryResponseDTO + +class TestServicingDataCategoryResponseDTO(unittest.TestCase): + """ServicingDataCategoryResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDataCategoryResponseDTO: + """Test ServicingDataCategoryResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDataCategoryResponseDTO` + """ + model = ServicingDataCategoryResponseDTO() + if include_optional: + return ServicingDataCategoryResponseDTO( + name = '', + id = '' + ) + else: + return ServicingDataCategoryResponseDTO( + ) + """ + + def testServicingDataCategoryResponseDTO(self): + """Test ServicingDataCategoryResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_data_security_profile_dto.py b/src/visier_platform_sdk/test/test_servicing_data_security_profile_dto.py new file mode 100644 index 0000000000..d2edd2ab1b --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_data_security_profile_dto.py @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_data_security_profile_dto import ServicingDataSecurityProfileDTO + +class TestServicingDataSecurityProfileDTO(unittest.TestCase): + """ServicingDataSecurityProfileDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDataSecurityProfileDTO: + """Test ServicingDataSecurityProfileDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDataSecurityProfileDTO` + """ + model = ServicingDataSecurityProfileDTO() + if include_optional: + return ServicingDataSecurityProfileDTO( + analytic_object_id = '', + property_set_config = visier_platform_sdk.models.servicing/property_set_config_dto.servicing.PropertySetConfigDTO( + property_access_configs = [ + visier_platform_sdk.models.servicing/property_access_config_dto.servicing.PropertyAccessConfigDTO( + property_id = '', + analytic_object_id = '', + analytic_object_reference_paths = [ + '' + ], + access_level = 'None', + property_status = 'Unset', ) + ], + shareable_data_access_set = None, ), + all_data_point_access = True, + member_filter_configs = [ + visier_platform_sdk.models.servicing/member_filter_config_dto.servicing.MemberFilterConfigDTO( + dimension_filters = [ + visier_platform_sdk.models.servicing/dimension_filter_dto.servicing.DimensionFilterDTO( + static_dimension_filter = visier_platform_sdk.models.servicing/static_dimension_filter_dto.servicing.StaticDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + member_selections = [ + visier_platform_sdk.models.servicing/member_selection_dto.servicing.MemberSelectionDTO( + name_path = [ + '' + ], + excluded = True, + dimension_member_status = 'Unset', ) + ], + dimension_status = 'Unset', ), + dynamic_dimension_filter = visier_platform_sdk.models.servicing/dynamic_dimension_filter_dto.servicing.DynamicDimensionFilterDTO( + dimension_id = '', + dynamic_property_mappings = [ + visier_platform_sdk.models.servicing/dynamic_property_mapping_dto.servicing.DynamicPropertyMappingDTO( + hierarchy_property_id = '', + user_property = None, + hierarchy_property_status = 'Unset', ) + ], + dimension_status = 'Unset', ), ) + ], ) + ], + inherited_access_configs = [ + visier_platform_sdk.models.servicing/inherited_access_config_dto.servicing.InheritedAccessConfigDTO( + analytic_object_id = '', + remove_access = True, + member_filter_configs = [ + visier_platform_sdk.models.servicing/member_filter_config_dto.servicing.MemberFilterConfigDTO( + dimension_filters = [ + visier_platform_sdk.models.servicing/dimension_filter_dto.servicing.DimensionFilterDTO( + static_dimension_filter = visier_platform_sdk.models.servicing/static_dimension_filter_dto.servicing.StaticDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + member_selections = [ + visier_platform_sdk.models.servicing/member_selection_dto.servicing.MemberSelectionDTO( + name_path = [ + '' + ], + excluded = True, + dimension_member_status = 'Unset', ) + ], + dimension_status = 'Unset', ), + dynamic_dimension_filter = visier_platform_sdk.models.servicing/dynamic_dimension_filter_dto.servicing.DynamicDimensionFilterDTO( + dimension_id = '', + dynamic_property_mappings = [ + visier_platform_sdk.models.servicing/dynamic_property_mapping_dto.servicing.DynamicPropertyMappingDTO( + hierarchy_property_id = '', + user_property = None, + hierarchy_property_status = 'Unset', ) + ], + dimension_status = 'Unset', ), ) + ], ) + ], ) + ], + inherited_reference_member_filter_config = visier_platform_sdk.models.servicing/inherited_reference_member_filter_config_dto.servicing.InheritedReferenceMemberFilterConfigDTO( + target_analytic_object_id = '', + analytic_object_reference = '', ), + analytic_object_status = 'Unset' + ) + else: + return ServicingDataSecurityProfileDTO( + ) + """ + + def testServicingDataSecurityProfileDTO(self): + """Test ServicingDataSecurityProfileDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_delete_permissions_request_dto.py b/src/visier_platform_sdk/test/test_servicing_delete_permissions_request_dto.py new file mode 100644 index 0000000000..753b203ccc --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_delete_permissions_request_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_delete_permissions_request_dto import ServicingDeletePermissionsRequestDTO + +class TestServicingDeletePermissionsRequestDTO(unittest.TestCase): + """ServicingDeletePermissionsRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDeletePermissionsRequestDTO: + """Test ServicingDeletePermissionsRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDeletePermissionsRequestDTO` + """ + model = ServicingDeletePermissionsRequestDTO() + if include_optional: + return ServicingDeletePermissionsRequestDTO( + permission_ids = [ + '' + ] + ) + else: + return ServicingDeletePermissionsRequestDTO( + ) + """ + + def testServicingDeletePermissionsRequestDTO(self): + """Test ServicingDeletePermissionsRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_dimension_filter_dto.py b/src/visier_platform_sdk/test/test_servicing_dimension_filter_dto.py new file mode 100644 index 0000000000..f7e067d890 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_dimension_filter_dto.py @@ -0,0 +1,77 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_dimension_filter_dto import ServicingDimensionFilterDTO + +class TestServicingDimensionFilterDTO(unittest.TestCase): + """ServicingDimensionFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDimensionFilterDTO: + """Test ServicingDimensionFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDimensionFilterDTO` + """ + model = ServicingDimensionFilterDTO() + if include_optional: + return ServicingDimensionFilterDTO( + static_dimension_filter = visier_platform_sdk.models.servicing/static_dimension_filter_dto.servicing.StaticDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + member_selections = [ + visier_platform_sdk.models.servicing/member_selection_dto.servicing.MemberSelectionDTO( + name_path = [ + '' + ], + excluded = True, + dimension_member_status = 'Unset', ) + ], + dimension_status = 'Unset', ), + dynamic_dimension_filter = visier_platform_sdk.models.servicing/dynamic_dimension_filter_dto.servicing.DynamicDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + dynamic_property_mappings = [ + visier_platform_sdk.models.servicing/dynamic_property_mapping_dto.servicing.DynamicPropertyMappingDTO( + hierarchy_property_id = '', + user_property = None, + hierarchy_property_status = 'Unset', ) + ], + dimension_status = 'Unset', ) + ) + else: + return ServicingDimensionFilterDTO( + ) + """ + + def testServicingDimensionFilterDTO(self): + """Test ServicingDimensionFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_direct_data_job_config_dto.py b/src/visier_platform_sdk/test/test_servicing_direct_data_job_config_dto.py new file mode 100644 index 0000000000..8c7a4aee56 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_direct_data_job_config_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_direct_data_job_config_dto import ServicingDirectDataJobConfigDTO + +class TestServicingDirectDataJobConfigDTO(unittest.TestCase): + """ServicingDirectDataJobConfigDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDirectDataJobConfigDTO: + """Test ServicingDirectDataJobConfigDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDirectDataJobConfigDTO` + """ + model = ServicingDirectDataJobConfigDTO() + if include_optional: + return ServicingDirectDataJobConfigDTO( + supplemental_mode = 'UNCHANGED', + extend_objects = [ + '' + ] + ) + else: + return ServicingDirectDataJobConfigDTO( + ) + """ + + def testServicingDirectDataJobConfigDTO(self): + """Test ServicingDirectDataJobConfigDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_direct_data_job_status_response_dto.py b/src/visier_platform_sdk/test/test_servicing_direct_data_job_status_response_dto.py new file mode 100644 index 0000000000..face99d8ff --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_direct_data_job_status_response_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_direct_data_job_status_response_dto import ServicingDirectDataJobStatusResponseDTO + +class TestServicingDirectDataJobStatusResponseDTO(unittest.TestCase): + """ServicingDirectDataJobStatusResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDirectDataJobStatusResponseDTO: + """Test ServicingDirectDataJobStatusResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDirectDataJobStatusResponseDTO` + """ + model = ServicingDirectDataJobStatusResponseDTO() + if include_optional: + return ServicingDirectDataJobStatusResponseDTO( + tenant_code = '', + transaction_id = '', + job_id = '', + status = '', + message = '' + ) + else: + return ServicingDirectDataJobStatusResponseDTO( + ) + """ + + def testServicingDirectDataJobStatusResponseDTO(self): + """Test ServicingDirectDataJobStatusResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_direct_data_list_transactions_response_dto.py b/src/visier_platform_sdk/test/test_servicing_direct_data_list_transactions_response_dto.py new file mode 100644 index 0000000000..8595e318b2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_direct_data_list_transactions_response_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_direct_data_list_transactions_response_dto import ServicingDirectDataListTransactionsResponseDTO + +class TestServicingDirectDataListTransactionsResponseDTO(unittest.TestCase): + """ServicingDirectDataListTransactionsResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDirectDataListTransactionsResponseDTO: + """Test ServicingDirectDataListTransactionsResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDirectDataListTransactionsResponseDTO` + """ + model = ServicingDirectDataListTransactionsResponseDTO() + if include_optional: + return ServicingDirectDataListTransactionsResponseDTO( + transactions = [ + visier_platform_sdk.models.servicing/direct_data_transaction_dto.servicing.DirectDataTransactionDTO( + tenant_code = '', + transaction_id = '', + created = '', + updated = '', + status = '', ) + ] + ) + else: + return ServicingDirectDataListTransactionsResponseDTO( + ) + """ + + def testServicingDirectDataListTransactionsResponseDTO(self): + """Test ServicingDirectDataListTransactionsResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_direct_data_load_config_dto.py b/src/visier_platform_sdk/test/test_servicing_direct_data_load_config_dto.py new file mode 100644 index 0000000000..fa5d58db35 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_direct_data_load_config_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_direct_data_load_config_dto import ServicingDirectDataLoadConfigDTO + +class TestServicingDirectDataLoadConfigDTO(unittest.TestCase): + """ServicingDirectDataLoadConfigDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDirectDataLoadConfigDTO: + """Test ServicingDirectDataLoadConfigDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDirectDataLoadConfigDTO` + """ + model = ServicingDirectDataLoadConfigDTO() + if include_optional: + return ServicingDirectDataLoadConfigDTO( + job = visier_platform_sdk.models.servicing/direct_data_job_config_dto.servicing.DirectDataJobConfigDTO( + supplemental_mode = 'UNCHANGED', + extend_objects = [ + '' + ], ) + ) + else: + return ServicingDirectDataLoadConfigDTO( + ) + """ + + def testServicingDirectDataLoadConfigDTO(self): + """Test ServicingDirectDataLoadConfigDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_direct_data_schema_dto.py b/src/visier_platform_sdk/test/test_servicing_direct_data_schema_dto.py new file mode 100644 index 0000000000..a135cdcc0f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_direct_data_schema_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_direct_data_schema_dto import ServicingDirectDataSchemaDTO + +class TestServicingDirectDataSchemaDTO(unittest.TestCase): + """ServicingDirectDataSchemaDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDirectDataSchemaDTO: + """Test ServicingDirectDataSchemaDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDirectDataSchemaDTO` + """ + model = ServicingDirectDataSchemaDTO() + if include_optional: + return ServicingDirectDataSchemaDTO( + var_schema = [ + visier_platform_sdk.models.servicing/direct_data_schema_field_dto.servicing.DirectDataSchemaFieldDTO( + name = '', + data_type = '', + formats = [ + '' + ], + is_mandatory = True, + empty_values_allowed = True, ) + ] + ) + else: + return ServicingDirectDataSchemaDTO( + ) + """ + + def testServicingDirectDataSchemaDTO(self): + """Test ServicingDirectDataSchemaDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_direct_data_schema_field_dto.py b/src/visier_platform_sdk/test/test_servicing_direct_data_schema_field_dto.py new file mode 100644 index 0000000000..a4db1b07d1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_direct_data_schema_field_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_direct_data_schema_field_dto import ServicingDirectDataSchemaFieldDTO + +class TestServicingDirectDataSchemaFieldDTO(unittest.TestCase): + """ServicingDirectDataSchemaFieldDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDirectDataSchemaFieldDTO: + """Test ServicingDirectDataSchemaFieldDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDirectDataSchemaFieldDTO` + """ + model = ServicingDirectDataSchemaFieldDTO() + if include_optional: + return ServicingDirectDataSchemaFieldDTO( + name = '', + data_type = '', + formats = [ + '' + ], + is_mandatory = True, + empty_values_allowed = True + ) + else: + return ServicingDirectDataSchemaFieldDTO( + ) + """ + + def testServicingDirectDataSchemaFieldDTO(self): + """Test ServicingDirectDataSchemaFieldDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_direct_data_transaction_dto.py b/src/visier_platform_sdk/test/test_servicing_direct_data_transaction_dto.py new file mode 100644 index 0000000000..eb06831e95 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_direct_data_transaction_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_direct_data_transaction_dto import ServicingDirectDataTransactionDTO + +class TestServicingDirectDataTransactionDTO(unittest.TestCase): + """ServicingDirectDataTransactionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDirectDataTransactionDTO: + """Test ServicingDirectDataTransactionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDirectDataTransactionDTO` + """ + model = ServicingDirectDataTransactionDTO() + if include_optional: + return ServicingDirectDataTransactionDTO( + tenant_code = '', + transaction_id = '', + created = '', + updated = '', + status = '' + ) + else: + return ServicingDirectDataTransactionDTO( + ) + """ + + def testServicingDirectDataTransactionDTO(self): + """Test ServicingDirectDataTransactionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_direct_data_transaction_start_response_dto.py b/src/visier_platform_sdk/test/test_servicing_direct_data_transaction_start_response_dto.py new file mode 100644 index 0000000000..957efc1de4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_direct_data_transaction_start_response_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_direct_data_transaction_start_response_dto import ServicingDirectDataTransactionStartResponseDTO + +class TestServicingDirectDataTransactionStartResponseDTO(unittest.TestCase): + """ServicingDirectDataTransactionStartResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDirectDataTransactionStartResponseDTO: + """Test ServicingDirectDataTransactionStartResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDirectDataTransactionStartResponseDTO` + """ + model = ServicingDirectDataTransactionStartResponseDTO() + if include_optional: + return ServicingDirectDataTransactionStartResponseDTO( + transaction_id = '' + ) + else: + return ServicingDirectDataTransactionStartResponseDTO( + ) + """ + + def testServicingDirectDataTransactionStartResponseDTO(self): + """Test ServicingDirectDataTransactionStartResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_direct_data_upload_file_response_dto.py b/src/visier_platform_sdk/test/test_servicing_direct_data_upload_file_response_dto.py new file mode 100644 index 0000000000..ac51958756 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_direct_data_upload_file_response_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_direct_data_upload_file_response_dto import ServicingDirectDataUploadFileResponseDTO + +class TestServicingDirectDataUploadFileResponseDTO(unittest.TestCase): + """ServicingDirectDataUploadFileResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDirectDataUploadFileResponseDTO: + """Test ServicingDirectDataUploadFileResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDirectDataUploadFileResponseDTO` + """ + model = ServicingDirectDataUploadFileResponseDTO() + if include_optional: + return ServicingDirectDataUploadFileResponseDTO( + transaction_id = '', + status = '', + message = '' + ) + else: + return ServicingDirectDataUploadFileResponseDTO( + ) + """ + + def testServicingDirectDataUploadFileResponseDTO(self): + """Test ServicingDirectDataUploadFileResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_document_search_link_dto.py b/src/visier_platform_sdk/test/test_servicing_document_search_link_dto.py new file mode 100644 index 0000000000..8febbbcf7d --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_document_search_link_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_document_search_link_dto import ServicingDocumentSearchLinkDTO + +class TestServicingDocumentSearchLinkDTO(unittest.TestCase): + """ServicingDocumentSearchLinkDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDocumentSearchLinkDTO: + """Test ServicingDocumentSearchLinkDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDocumentSearchLinkDTO` + """ + model = ServicingDocumentSearchLinkDTO() + if include_optional: + return ServicingDocumentSearchLinkDTO( + href = '', + verb = '' + ) + else: + return ServicingDocumentSearchLinkDTO( + ) + """ + + def testServicingDocumentSearchLinkDTO(self): + """Test ServicingDocumentSearchLinkDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_dynamic_dimension_filter_dto.py b/src/visier_platform_sdk/test/test_servicing_dynamic_dimension_filter_dto.py new file mode 100644 index 0000000000..14d6ab0e6a --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_dynamic_dimension_filter_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_dynamic_dimension_filter_dto import ServicingDynamicDimensionFilterDTO + +class TestServicingDynamicDimensionFilterDTO(unittest.TestCase): + """ServicingDynamicDimensionFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDynamicDimensionFilterDTO: + """Test ServicingDynamicDimensionFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDynamicDimensionFilterDTO` + """ + model = ServicingDynamicDimensionFilterDTO() + if include_optional: + return ServicingDynamicDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + dynamic_property_mappings = [ + visier_platform_sdk.models.servicing/dynamic_property_mapping_dto.servicing.DynamicPropertyMappingDTO( + hierarchy_property_id = '', + user_property = None, + hierarchy_property_status = 'Unset', ) + ], + dimension_status = 'Unset' + ) + else: + return ServicingDynamicDimensionFilterDTO( + ) + """ + + def testServicingDynamicDimensionFilterDTO(self): + """Test ServicingDynamicDimensionFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_dynamic_property_mapping_dto.py b/src/visier_platform_sdk/test/test_servicing_dynamic_property_mapping_dto.py new file mode 100644 index 0000000000..ce6e8e1d29 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_dynamic_property_mapping_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_dynamic_property_mapping_dto import ServicingDynamicPropertyMappingDTO + +class TestServicingDynamicPropertyMappingDTO(unittest.TestCase): + """ServicingDynamicPropertyMappingDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingDynamicPropertyMappingDTO: + """Test ServicingDynamicPropertyMappingDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingDynamicPropertyMappingDTO` + """ + model = ServicingDynamicPropertyMappingDTO() + if include_optional: + return ServicingDynamicPropertyMappingDTO( + hierarchy_property_id = '', + user_property = visier_platform_sdk.models.servicing/user_property_dto.servicing.UserPropertyDTO( + name = '', ), + hierarchy_property_status = 'Unset' + ) + else: + return ServicingDynamicPropertyMappingDTO( + ) + """ + + def testServicingDynamicPropertyMappingDTO(self): + """Test ServicingDynamicPropertyMappingDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_error_dto.py b/src/visier_platform_sdk/test/test_servicing_error_dto.py new file mode 100644 index 0000000000..6f06a70ae6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_error_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_error_dto import ServicingErrorDTO + +class TestServicingErrorDTO(unittest.TestCase): + """ServicingErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingErrorDTO: + """Test ServicingErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingErrorDTO` + """ + model = ServicingErrorDTO() + if include_optional: + return ServicingErrorDTO( + root_cause_id = '', + error_code = '', + error_message = '' + ) + else: + return ServicingErrorDTO( + ) + """ + + def testServicingErrorDTO(self): + """Test ServicingErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_export_production_versions_api_operation_parameters_dto.py b/src/visier_platform_sdk/test/test_servicing_export_production_versions_api_operation_parameters_dto.py new file mode 100644 index 0000000000..919701dd0f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_export_production_versions_api_operation_parameters_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_export_production_versions_api_operation_parameters_dto import ServicingExportProductionVersionsAPIOperationParametersDTO + +class TestServicingExportProductionVersionsAPIOperationParametersDTO(unittest.TestCase): + """ServicingExportProductionVersionsAPIOperationParametersDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingExportProductionVersionsAPIOperationParametersDTO: + """Test ServicingExportProductionVersionsAPIOperationParametersDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingExportProductionVersionsAPIOperationParametersDTO` + """ + model = ServicingExportProductionVersionsAPIOperationParametersDTO() + if include_optional: + return ServicingExportProductionVersionsAPIOperationParametersDTO( + start_version = '', + end_version = '', + excluded_versions = [ + '' + ] + ) + else: + return ServicingExportProductionVersionsAPIOperationParametersDTO( + ) + """ + + def testServicingExportProductionVersionsAPIOperationParametersDTO(self): + """Test ServicingExportProductionVersionsAPIOperationParametersDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_failed_accessible_tenant_profile_assignment_dto.py b/src/visier_platform_sdk/test/test_servicing_failed_accessible_tenant_profile_assignment_dto.py new file mode 100644 index 0000000000..551547f49d --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_failed_accessible_tenant_profile_assignment_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_failed_accessible_tenant_profile_assignment_dto import ServicingFailedAccessibleTenantProfileAssignmentDTO + +class TestServicingFailedAccessibleTenantProfileAssignmentDTO(unittest.TestCase): + """ServicingFailedAccessibleTenantProfileAssignmentDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingFailedAccessibleTenantProfileAssignmentDTO: + """Test ServicingFailedAccessibleTenantProfileAssignmentDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingFailedAccessibleTenantProfileAssignmentDTO` + """ + model = ServicingFailedAccessibleTenantProfileAssignmentDTO() + if include_optional: + return ServicingFailedAccessibleTenantProfileAssignmentDTO( + user_id = '', + tenant_code = '', + for_all_children = True, + error = visier_platform_sdk.models.servicing/error_dto.servicing.ErrorDTO( + root_cause_id = '', + error_code = '', + error_message = '', ) + ) + else: + return ServicingFailedAccessibleTenantProfileAssignmentDTO( + ) + """ + + def testServicingFailedAccessibleTenantProfileAssignmentDTO(self): + """Test ServicingFailedAccessibleTenantProfileAssignmentDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_failed_local_tenant_profile_assignment_dto.py b/src/visier_platform_sdk/test/test_servicing_failed_local_tenant_profile_assignment_dto.py new file mode 100644 index 0000000000..8c8888ebf9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_failed_local_tenant_profile_assignment_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_failed_local_tenant_profile_assignment_dto import ServicingFailedLocalTenantProfileAssignmentDTO + +class TestServicingFailedLocalTenantProfileAssignmentDTO(unittest.TestCase): + """ServicingFailedLocalTenantProfileAssignmentDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingFailedLocalTenantProfileAssignmentDTO: + """Test ServicingFailedLocalTenantProfileAssignmentDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingFailedLocalTenantProfileAssignmentDTO` + """ + model = ServicingFailedLocalTenantProfileAssignmentDTO() + if include_optional: + return ServicingFailedLocalTenantProfileAssignmentDTO( + user_id = '', + error = visier_platform_sdk.models.servicing/error_dto.servicing.ErrorDTO( + root_cause_id = '', + error_code = '', + error_message = '', ) + ) + else: + return ServicingFailedLocalTenantProfileAssignmentDTO( + ) + """ + + def testServicingFailedLocalTenantProfileAssignmentDTO(self): + """Test ServicingFailedLocalTenantProfileAssignmentDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_failed_local_tenant_profile_revoke_dto.py b/src/visier_platform_sdk/test/test_servicing_failed_local_tenant_profile_revoke_dto.py new file mode 100644 index 0000000000..2068b833ee --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_failed_local_tenant_profile_revoke_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_failed_local_tenant_profile_revoke_dto import ServicingFailedLocalTenantProfileRevokeDTO + +class TestServicingFailedLocalTenantProfileRevokeDTO(unittest.TestCase): + """ServicingFailedLocalTenantProfileRevokeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingFailedLocalTenantProfileRevokeDTO: + """Test ServicingFailedLocalTenantProfileRevokeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingFailedLocalTenantProfileRevokeDTO` + """ + model = ServicingFailedLocalTenantProfileRevokeDTO() + if include_optional: + return ServicingFailedLocalTenantProfileRevokeDTO( + user_id = '', + message = '' + ) + else: + return ServicingFailedLocalTenantProfileRevokeDTO( + ) + """ + + def testServicingFailedLocalTenantProfileRevokeDTO(self): + """Test ServicingFailedLocalTenantProfileRevokeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_get_capabilities_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_get_capabilities_api_response_dto.py new file mode 100644 index 0000000000..d9eadf79fe --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_get_capabilities_api_response_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_get_capabilities_api_response_dto import ServicingGetCapabilitiesAPIResponseDTO + +class TestServicingGetCapabilitiesAPIResponseDTO(unittest.TestCase): + """ServicingGetCapabilitiesAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingGetCapabilitiesAPIResponseDTO: + """Test ServicingGetCapabilitiesAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingGetCapabilitiesAPIResponseDTO` + """ + model = ServicingGetCapabilitiesAPIResponseDTO() + if include_optional: + return ServicingGetCapabilitiesAPIResponseDTO( + capabilities = [ + visier_platform_sdk.models.servicing/capability_dto.servicing.CapabilityDTO( + name = '', + display_name = '', + description = '', ) + ] + ) + else: + return ServicingGetCapabilitiesAPIResponseDTO( + ) + """ + + def testServicingGetCapabilitiesAPIResponseDTO(self): + """Test ServicingGetCapabilitiesAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_get_content_packages_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_get_content_packages_api_response_dto.py new file mode 100644 index 0000000000..8bcd4ca0ed --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_get_content_packages_api_response_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_get_content_packages_api_response_dto import ServicingGetContentPackagesAPIResponseDTO + +class TestServicingGetContentPackagesAPIResponseDTO(unittest.TestCase): + """ServicingGetContentPackagesAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingGetContentPackagesAPIResponseDTO: + """Test ServicingGetContentPackagesAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingGetContentPackagesAPIResponseDTO` + """ + model = ServicingGetContentPackagesAPIResponseDTO() + if include_optional: + return ServicingGetContentPackagesAPIResponseDTO( + content_packages = [ + visier_platform_sdk.models.servicing/content_package_dto.servicing.ContentPackageDTO( + content_package_id = '', + display_name = '', + description = '', ) + ] + ) + else: + return ServicingGetContentPackagesAPIResponseDTO( + ) + """ + + def testServicingGetContentPackagesAPIResponseDTO(self): + """Test ServicingGetContentPackagesAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_get_data_access_sets_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_get_data_access_sets_api_response_dto.py new file mode 100644 index 0000000000..9232c6ec94 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_get_data_access_sets_api_response_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_get_data_access_sets_api_response_dto import ServicingGetDataAccessSetsAPIResponseDTO + +class TestServicingGetDataAccessSetsAPIResponseDTO(unittest.TestCase): + """ServicingGetDataAccessSetsAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingGetDataAccessSetsAPIResponseDTO: + """Test ServicingGetDataAccessSetsAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingGetDataAccessSetsAPIResponseDTO` + """ + model = ServicingGetDataAccessSetsAPIResponseDTO() + if include_optional: + return ServicingGetDataAccessSetsAPIResponseDTO( + data_access_sets = [ + visier_platform_sdk.models.servicing/data_access_set_dto.servicing.DataAccessSetDTO( + id = '', + display_name = '', + description = '', + analytic_object_id = '', + property_access_configs = [ + visier_platform_sdk.models.servicing/property_access_config_dto.servicing.PropertyAccessConfigDTO( + property_id = '', + analytic_object_id = '', + analytic_object_reference_paths = [ + '' + ], + access_level = 'None', + property_status = 'Unset', ) + ], ) + ] + ) + else: + return ServicingGetDataAccessSetsAPIResponseDTO( + ) + """ + + def testServicingGetDataAccessSetsAPIResponseDTO(self): + """Test ServicingGetDataAccessSetsAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_get_data_security_objects_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_get_data_security_objects_api_response_dto.py new file mode 100644 index 0000000000..87396e894f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_get_data_security_objects_api_response_dto.py @@ -0,0 +1,83 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_get_data_security_objects_api_response_dto import ServicingGetDataSecurityObjectsAPIResponseDTO + +class TestServicingGetDataSecurityObjectsAPIResponseDTO(unittest.TestCase): + """ServicingGetDataSecurityObjectsAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingGetDataSecurityObjectsAPIResponseDTO: + """Test ServicingGetDataSecurityObjectsAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingGetDataSecurityObjectsAPIResponseDTO` + """ + model = ServicingGetDataSecurityObjectsAPIResponseDTO() + if include_optional: + return ServicingGetDataSecurityObjectsAPIResponseDTO( + analytic_objects = [ + visier_platform_sdk.models.servicing/analytic_object_dto.servicing.AnalyticObjectDTO( + analytic_object_id = '', + display_name = '', + object_type = 'Event', + related_objects = [ + visier_platform_sdk.models.servicing/related_analytic_object_dto.servicing.RelatedAnalyticObjectDTO( + analytic_object_id = '', + display_name = '', ) + ], + securable_properties = [ + visier_platform_sdk.models.servicing/securable_property_dto.servicing.SecurablePropertyDTO( + property_id = '', + display_name = '', + analytic_object_id = '', + is_primary_key = True, + reference_symbol_name = '', ) + ], + securable_dimensions = [ + visier_platform_sdk.models.servicing/securable_dimension_dto.servicing.SecurableDimensionDTO( + dimension_id = '', + display_name = '', + analytic_object_ids = [ + '' + ], + hierarchy_properties = [ + visier_platform_sdk.models.servicing/hierarchy_property_dto.servicing.HierarchyPropertyDTO( + hierarchy_property_id = '', + display_name = '', ) + ], ) + ], ) + ] + ) + else: + return ServicingGetDataSecurityObjectsAPIResponseDTO( + ) + """ + + def testServicingGetDataSecurityObjectsAPIResponseDTO(self): + """Test ServicingGetDataSecurityObjectsAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_get_permissions_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_get_permissions_api_response_dto.py new file mode 100644 index 0000000000..946e79e0f9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_get_permissions_api_response_dto.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_get_permissions_api_response_dto import ServicingGetPermissionsAPIResponseDTO + +class TestServicingGetPermissionsAPIResponseDTO(unittest.TestCase): + """ServicingGetPermissionsAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingGetPermissionsAPIResponseDTO: + """Test ServicingGetPermissionsAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingGetPermissionsAPIResponseDTO` + """ + model = ServicingGetPermissionsAPIResponseDTO() + if include_optional: + return ServicingGetPermissionsAPIResponseDTO( + permissions = [ + visier_platform_sdk.models.servicing/permission_dto.servicing.PermissionDTO( + permission_id = '', + display_name = '', + description = '', + data_security_profiles = [ + visier_platform_sdk.models.servicing/data_security_profile_dto.servicing.DataSecurityProfileDTO( + analytic_object_id = '', + property_set_config = None, + all_data_point_access = True, + member_filter_configs = [ + visier_platform_sdk.models.servicing/member_filter_config_dto.servicing.MemberFilterConfigDTO( + dimension_filters = [ + visier_platform_sdk.models.servicing/dimension_filter_dto.servicing.DimensionFilterDTO( + static_dimension_filter = visier_platform_sdk.models.servicing/static_dimension_filter_dto.servicing.StaticDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + member_selections = [ + visier_platform_sdk.models.servicing/member_selection_dto.servicing.MemberSelectionDTO( + name_path = [ + '' + ], + excluded = True, + dimension_member_status = 'Unset', ) + ], + dimension_status = 'Unset', ), + dynamic_dimension_filter = visier_platform_sdk.models.servicing/dynamic_dimension_filter_dto.servicing.DynamicDimensionFilterDTO( + dimension_id = '', + dynamic_property_mappings = [ + visier_platform_sdk.models.servicing/dynamic_property_mapping_dto.servicing.DynamicPropertyMappingDTO( + hierarchy_property_id = '', + user_property = None, + hierarchy_property_status = 'Unset', ) + ], + dimension_status = 'Unset', ), ) + ], ) + ], + inherited_access_configs = [ + visier_platform_sdk.models.servicing/inherited_access_config_dto.servicing.InheritedAccessConfigDTO( + analytic_object_id = '', + remove_access = True, ) + ], + inherited_reference_member_filter_config = None, + analytic_object_status = 'Unset', ) + ], + admin_capability_config = None, + role_modules_config = None, ) + ] + ) + else: + return ServicingGetPermissionsAPIResponseDTO( + ) + """ + + def testServicingGetPermissionsAPIResponseDTO(self): + """Test ServicingGetPermissionsAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_get_production_versions_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_get_production_versions_api_response_dto.py new file mode 100644 index 0000000000..417cb0ed19 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_get_production_versions_api_response_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_get_production_versions_api_response_dto import ServicingGetProductionVersionsAPIResponseDTO + +class TestServicingGetProductionVersionsAPIResponseDTO(unittest.TestCase): + """ServicingGetProductionVersionsAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingGetProductionVersionsAPIResponseDTO: + """Test ServicingGetProductionVersionsAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingGetProductionVersionsAPIResponseDTO` + """ + model = ServicingGetProductionVersionsAPIResponseDTO() + if include_optional: + return ServicingGetProductionVersionsAPIResponseDTO( + published_versions = [ + visier_platform_sdk.models.servicing/project_dto.servicing.ProjectDTO( + id = '', + name = '', + description = '', + release_version = '', + ticket_number = '', + version_number = 56, + capabilities = [ + 'canRead' + ], ) + ] + ) + else: + return ServicingGetProductionVersionsAPIResponseDTO( + ) + """ + + def testServicingGetProductionVersionsAPIResponseDTO(self): + """Test ServicingGetProductionVersionsAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_get_projects_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_get_projects_api_response_dto.py new file mode 100644 index 0000000000..e69c3883a6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_get_projects_api_response_dto.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_get_projects_api_response_dto import ServicingGetProjectsAPIResponseDTO + +class TestServicingGetProjectsAPIResponseDTO(unittest.TestCase): + """ServicingGetProjectsAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingGetProjectsAPIResponseDTO: + """Test ServicingGetProjectsAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingGetProjectsAPIResponseDTO` + """ + model = ServicingGetProjectsAPIResponseDTO() + if include_optional: + return ServicingGetProjectsAPIResponseDTO( + open_projects = [ + visier_platform_sdk.models.servicing/project_dto.servicing.ProjectDTO( + id = '', + name = '', + description = '', + release_version = '', + ticket_number = '', + version_number = 56, + capabilities = [ + 'canRead' + ], ) + ], + approval_projects = [ + visier_platform_sdk.models.servicing/project_dto.servicing.ProjectDTO( + id = '', + name = '', + description = '', + release_version = '', + ticket_number = '', + version_number = 56, + capabilities = [ + 'canRead' + ], ) + ], + rejected_projects = [ + visier_platform_sdk.models.servicing/project_dto.servicing.ProjectDTO( + id = '', + name = '', + description = '', + release_version = '', + ticket_number = '', + version_number = 56, + capabilities = [ + 'canRead' + ], ) + ], + archived_projects = [ + visier_platform_sdk.models.servicing/project_dto.servicing.ProjectDTO( + id = '', + name = '', + description = '', + release_version = '', + ticket_number = '', + version_number = 56, + capabilities = [ + 'canRead' + ], ) + ] + ) + else: + return ServicingGetProjectsAPIResponseDTO( + ) + """ + + def testServicingGetProjectsAPIResponseDTO(self): + """Test ServicingGetProjectsAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_hierarchy_property_dto.py b/src/visier_platform_sdk/test/test_servicing_hierarchy_property_dto.py new file mode 100644 index 0000000000..3813c5e133 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_hierarchy_property_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_hierarchy_property_dto import ServicingHierarchyPropertyDTO + +class TestServicingHierarchyPropertyDTO(unittest.TestCase): + """ServicingHierarchyPropertyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingHierarchyPropertyDTO: + """Test ServicingHierarchyPropertyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingHierarchyPropertyDTO` + """ + model = ServicingHierarchyPropertyDTO() + if include_optional: + return ServicingHierarchyPropertyDTO( + hierarchy_property_id = '', + display_name = '' + ) + else: + return ServicingHierarchyPropertyDTO( + ) + """ + + def testServicingHierarchyPropertyDTO(self): + """Test ServicingHierarchyPropertyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_inherited_access_config_dto.py b/src/visier_platform_sdk/test/test_servicing_inherited_access_config_dto.py new file mode 100644 index 0000000000..8476d6319c --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_inherited_access_config_dto.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_inherited_access_config_dto import ServicingInheritedAccessConfigDTO + +class TestServicingInheritedAccessConfigDTO(unittest.TestCase): + """ServicingInheritedAccessConfigDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingInheritedAccessConfigDTO: + """Test ServicingInheritedAccessConfigDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingInheritedAccessConfigDTO` + """ + model = ServicingInheritedAccessConfigDTO() + if include_optional: + return ServicingInheritedAccessConfigDTO( + analytic_object_id = '', + remove_access = True, + member_filter_configs = [ + visier_platform_sdk.models.servicing/member_filter_config_dto.servicing.MemberFilterConfigDTO( + dimension_filters = [ + visier_platform_sdk.models.servicing/dimension_filter_dto.servicing.DimensionFilterDTO( + static_dimension_filter = visier_platform_sdk.models.servicing/static_dimension_filter_dto.servicing.StaticDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + member_selections = [ + visier_platform_sdk.models.servicing/member_selection_dto.servicing.MemberSelectionDTO( + name_path = [ + '' + ], + excluded = True, + dimension_member_status = 'Unset', ) + ], + dimension_status = 'Unset', ), + dynamic_dimension_filter = visier_platform_sdk.models.servicing/dynamic_dimension_filter_dto.servicing.DynamicDimensionFilterDTO( + dimension_id = '', + dynamic_property_mappings = [ + visier_platform_sdk.models.servicing/dynamic_property_mapping_dto.servicing.DynamicPropertyMappingDTO( + hierarchy_property_id = '', + user_property = None, + hierarchy_property_status = 'Unset', ) + ], + dimension_status = 'Unset', ), ) + ], ) + ] + ) + else: + return ServicingInheritedAccessConfigDTO( + ) + """ + + def testServicingInheritedAccessConfigDTO(self): + """Test ServicingInheritedAccessConfigDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_inherited_reference_member_filter_config_dto.py b/src/visier_platform_sdk/test/test_servicing_inherited_reference_member_filter_config_dto.py new file mode 100644 index 0000000000..0e3426068c --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_inherited_reference_member_filter_config_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_inherited_reference_member_filter_config_dto import ServicingInheritedReferenceMemberFilterConfigDTO + +class TestServicingInheritedReferenceMemberFilterConfigDTO(unittest.TestCase): + """ServicingInheritedReferenceMemberFilterConfigDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingInheritedReferenceMemberFilterConfigDTO: + """Test ServicingInheritedReferenceMemberFilterConfigDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingInheritedReferenceMemberFilterConfigDTO` + """ + model = ServicingInheritedReferenceMemberFilterConfigDTO() + if include_optional: + return ServicingInheritedReferenceMemberFilterConfigDTO( + target_analytic_object_id = '', + analytic_object_reference = '' + ) + else: + return ServicingInheritedReferenceMemberFilterConfigDTO( + ) + """ + + def testServicingInheritedReferenceMemberFilterConfigDTO(self): + """Test ServicingInheritedReferenceMemberFilterConfigDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_job_id_response.py b/src/visier_platform_sdk/test/test_servicing_job_id_response.py new file mode 100644 index 0000000000..b5214de2cd --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_job_id_response.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_job_id_response import ServicingJobIdResponse + +class TestServicingJobIdResponse(unittest.TestCase): + """ServicingJobIdResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingJobIdResponse: + """Test ServicingJobIdResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingJobIdResponse` + """ + model = ServicingJobIdResponse() + if include_optional: + return ServicingJobIdResponse( + job_id = '' + ) + else: + return ServicingJobIdResponse( + ) + """ + + def testServicingJobIdResponse(self): + """Test ServicingJobIdResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_last_login_dto.py b/src/visier_platform_sdk/test/test_servicing_last_login_dto.py new file mode 100644 index 0000000000..a23d4e907e --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_last_login_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_last_login_dto import ServicingLastLoginDTO + +class TestServicingLastLoginDTO(unittest.TestCase): + """ServicingLastLoginDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingLastLoginDTO: + """Test ServicingLastLoginDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingLastLoginDTO` + """ + model = ServicingLastLoginDTO() + if include_optional: + return ServicingLastLoginDTO( + timestamp = '' + ) + else: + return ServicingLastLoginDTO( + ) + """ + + def testServicingLastLoginDTO(self): + """Test ServicingLastLoginDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_assignment_request_dto.py b/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_assignment_request_dto.py new file mode 100644 index 0000000000..64beda42bb --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_assignment_request_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_local_tenant_profile_assignment_request_dto import ServicingLocalTenantProfileAssignmentRequestDTO + +class TestServicingLocalTenantProfileAssignmentRequestDTO(unittest.TestCase): + """ServicingLocalTenantProfileAssignmentRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingLocalTenantProfileAssignmentRequestDTO: + """Test ServicingLocalTenantProfileAssignmentRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingLocalTenantProfileAssignmentRequestDTO` + """ + model = ServicingLocalTenantProfileAssignmentRequestDTO() + if include_optional: + return ServicingLocalTenantProfileAssignmentRequestDTO( + target_user_ids = [ + '' + ], + validity_start_time = '', + validity_end_time = '' + ) + else: + return ServicingLocalTenantProfileAssignmentRequestDTO( + ) + """ + + def testServicingLocalTenantProfileAssignmentRequestDTO(self): + """Test ServicingLocalTenantProfileAssignmentRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_assignment_response_dto.py b/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_assignment_response_dto.py new file mode 100644 index 0000000000..bd2b30ba6e --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_assignment_response_dto.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_local_tenant_profile_assignment_response_dto import ServicingLocalTenantProfileAssignmentResponseDTO + +class TestServicingLocalTenantProfileAssignmentResponseDTO(unittest.TestCase): + """ServicingLocalTenantProfileAssignmentResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingLocalTenantProfileAssignmentResponseDTO: + """Test ServicingLocalTenantProfileAssignmentResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingLocalTenantProfileAssignmentResponseDTO` + """ + model = ServicingLocalTenantProfileAssignmentResponseDTO() + if include_optional: + return ServicingLocalTenantProfileAssignmentResponseDTO( + errors = True, + bad_user_ids = [ + visier_platform_sdk.models.servicing/user_id_error_dto.servicing.UserIdErrorDTO( + user_id = '', + error = None, ) + ], + failed_assignments = [ + visier_platform_sdk.models.servicing/failed_local_tenant_profile_assignment_dto.servicing.FailedLocalTenantProfileAssignmentDTO( + user_id = '', + error = None, ) + ], + successful_assignments = [ + visier_platform_sdk.models.servicing/successful_local_tenant_profile_assignment_dto.servicing.SuccessfulLocalTenantProfileAssignmentDTO( + user_id = '', ) + ] + ) + else: + return ServicingLocalTenantProfileAssignmentResponseDTO( + ) + """ + + def testServicingLocalTenantProfileAssignmentResponseDTO(self): + """Test ServicingLocalTenantProfileAssignmentResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_revoke_request_dto.py b/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_revoke_request_dto.py new file mode 100644 index 0000000000..4770a91e67 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_revoke_request_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_local_tenant_profile_revoke_request_dto import ServicingLocalTenantProfileRevokeRequestDTO + +class TestServicingLocalTenantProfileRevokeRequestDTO(unittest.TestCase): + """ServicingLocalTenantProfileRevokeRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingLocalTenantProfileRevokeRequestDTO: + """Test ServicingLocalTenantProfileRevokeRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingLocalTenantProfileRevokeRequestDTO` + """ + model = ServicingLocalTenantProfileRevokeRequestDTO() + if include_optional: + return ServicingLocalTenantProfileRevokeRequestDTO( + target_user_ids = [ + '' + ] + ) + else: + return ServicingLocalTenantProfileRevokeRequestDTO( + ) + """ + + def testServicingLocalTenantProfileRevokeRequestDTO(self): + """Test ServicingLocalTenantProfileRevokeRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_revoke_response_dto.py b/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_revoke_response_dto.py new file mode 100644 index 0000000000..46d69b266a --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_local_tenant_profile_revoke_response_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_local_tenant_profile_revoke_response_dto import ServicingLocalTenantProfileRevokeResponseDTO + +class TestServicingLocalTenantProfileRevokeResponseDTO(unittest.TestCase): + """ServicingLocalTenantProfileRevokeResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingLocalTenantProfileRevokeResponseDTO: + """Test ServicingLocalTenantProfileRevokeResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingLocalTenantProfileRevokeResponseDTO` + """ + model = ServicingLocalTenantProfileRevokeResponseDTO() + if include_optional: + return ServicingLocalTenantProfileRevokeResponseDTO( + failed = [ + visier_platform_sdk.models.servicing/failed_local_tenant_profile_revoke_dto.servicing.FailedLocalTenantProfileRevokeDTO( + user_id = '', + message = '', ) + ], + succeeded = [ + visier_platform_sdk.models.servicing/successful_local_tenant_profile_assignment_dto.servicing.SuccessfulLocalTenantProfileAssignmentDTO( + user_id = '', ) + ] + ) + else: + return ServicingLocalTenantProfileRevokeResponseDTO( + ) + """ + + def testServicingLocalTenantProfileRevokeResponseDTO(self): + """Test ServicingLocalTenantProfileRevokeResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_member_filter_config_dto.py b/src/visier_platform_sdk/test/test_servicing_member_filter_config_dto.py new file mode 100644 index 0000000000..698ae226a9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_member_filter_config_dto.py @@ -0,0 +1,77 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_member_filter_config_dto import ServicingMemberFilterConfigDTO + +class TestServicingMemberFilterConfigDTO(unittest.TestCase): + """ServicingMemberFilterConfigDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingMemberFilterConfigDTO: + """Test ServicingMemberFilterConfigDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingMemberFilterConfigDTO` + """ + model = ServicingMemberFilterConfigDTO() + if include_optional: + return ServicingMemberFilterConfigDTO( + dimension_filters = [ + visier_platform_sdk.models.servicing/dimension_filter_dto.servicing.DimensionFilterDTO( + static_dimension_filter = visier_platform_sdk.models.servicing/static_dimension_filter_dto.servicing.StaticDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + member_selections = [ + visier_platform_sdk.models.servicing/member_selection_dto.servicing.MemberSelectionDTO( + name_path = [ + '' + ], + excluded = True, + dimension_member_status = 'Unset', ) + ], + dimension_status = 'Unset', ), + dynamic_dimension_filter = visier_platform_sdk.models.servicing/dynamic_dimension_filter_dto.servicing.DynamicDimensionFilterDTO( + dimension_id = '', + dynamic_property_mappings = [ + visier_platform_sdk.models.servicing/dynamic_property_mapping_dto.servicing.DynamicPropertyMappingDTO( + hierarchy_property_id = '', + user_property = None, + hierarchy_property_status = 'Unset', ) + ], + dimension_status = 'Unset', ), ) + ] + ) + else: + return ServicingMemberFilterConfigDTO( + ) + """ + + def testServicingMemberFilterConfigDTO(self): + """Test ServicingMemberFilterConfigDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_member_selection_dto.py b/src/visier_platform_sdk/test/test_servicing_member_selection_dto.py new file mode 100644 index 0000000000..9c66041b79 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_member_selection_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_member_selection_dto import ServicingMemberSelectionDTO + +class TestServicingMemberSelectionDTO(unittest.TestCase): + """ServicingMemberSelectionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingMemberSelectionDTO: + """Test ServicingMemberSelectionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingMemberSelectionDTO` + """ + model = ServicingMemberSelectionDTO() + if include_optional: + return ServicingMemberSelectionDTO( + name_path = [ + '' + ], + excluded = True, + dimension_member_status = 'Unset' + ) + else: + return ServicingMemberSelectionDTO( + ) + """ + + def testServicingMemberSelectionDTO(self): + """Test ServicingMemberSelectionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_calculated_property_type_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_calculated_property_type_dto.py new file mode 100644 index 0000000000..6d1f00ef77 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_calculated_property_type_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_calculated_property_type_dto import ServicingObjectconfigurationCalculatedPropertyTypeDTO + +class TestServicingObjectconfigurationCalculatedPropertyTypeDTO(unittest.TestCase): + """ServicingObjectconfigurationCalculatedPropertyTypeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationCalculatedPropertyTypeDTO: + """Test ServicingObjectconfigurationCalculatedPropertyTypeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationCalculatedPropertyTypeDTO` + """ + model = ServicingObjectconfigurationCalculatedPropertyTypeDTO() + if include_optional: + return ServicingObjectconfigurationCalculatedPropertyTypeDTO( + data_type = '', + formula = '' + ) + else: + return ServicingObjectconfigurationCalculatedPropertyTypeDTO( + ) + """ + + def testServicingObjectconfigurationCalculatedPropertyTypeDTO(self): + """Test ServicingObjectconfigurationCalculatedPropertyTypeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dependent_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dependent_dto.py new file mode 100644 index 0000000000..24d7716122 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dependent_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_dependent_dto import ServicingObjectconfigurationDependentDTO + +class TestServicingObjectconfigurationDependentDTO(unittest.TestCase): + """ServicingObjectconfigurationDependentDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationDependentDTO: + """Test ServicingObjectconfigurationDependentDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationDependentDTO` + """ + model = ServicingObjectconfigurationDependentDTO() + if include_optional: + return ServicingObjectconfigurationDependentDTO( + id = '', + display_name = '', + object_type = '' + ) + else: + return ServicingObjectconfigurationDependentDTO( + ) + """ + + def testServicingObjectconfigurationDependentDTO(self): + """Test ServicingObjectconfigurationDependentDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dimension_change_definition_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dimension_change_definition_dto.py new file mode 100644 index 0000000000..00bf55c16f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dimension_change_definition_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_dimension_change_definition_dto import ServicingObjectconfigurationDimensionChangeDefinitionDTO + +class TestServicingObjectconfigurationDimensionChangeDefinitionDTO(unittest.TestCase): + """ServicingObjectconfigurationDimensionChangeDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationDimensionChangeDefinitionDTO: + """Test ServicingObjectconfigurationDimensionChangeDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationDimensionChangeDefinitionDTO` + """ + model = ServicingObjectconfigurationDimensionChangeDefinitionDTO() + if include_optional: + return ServicingObjectconfigurationDimensionChangeDefinitionDTO( + id = '', + display_name = '', + short_display_name = '', + description = '' + ) + else: + return ServicingObjectconfigurationDimensionChangeDefinitionDTO( + ) + """ + + def testServicingObjectconfigurationDimensionChangeDefinitionDTO(self): + """Test ServicingObjectconfigurationDimensionChangeDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto.py new file mode 100644 index 0000000000..654dcb0793 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto import ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO + +class TestServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO(unittest.TestCase): + """ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO: + """Test ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO` + """ + model = ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO() + if include_optional: + return ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO( + tenant_code = '', + project_id = '', + dimensions = [ + visier_platform_sdk.models.servicing/objectconfiguration/dimension_change_definition_dto.servicing.objectconfiguration.DimensionChangeDefinitionDTO( + id = '', + display_name = '', + short_display_name = '', + description = '', ) + ] + ) + else: + return ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO( + ) + """ + + def testServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO(self): + """Test ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dimensions_change_definitions_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dimensions_change_definitions_dto.py new file mode 100644 index 0000000000..cff69ea3f6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_dimensions_change_definitions_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_dimensions_change_definitions_dto import ServicingObjectconfigurationDimensionsChangeDefinitionsDTO + +class TestServicingObjectconfigurationDimensionsChangeDefinitionsDTO(unittest.TestCase): + """ServicingObjectconfigurationDimensionsChangeDefinitionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationDimensionsChangeDefinitionsDTO: + """Test ServicingObjectconfigurationDimensionsChangeDefinitionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationDimensionsChangeDefinitionsDTO` + """ + model = ServicingObjectconfigurationDimensionsChangeDefinitionsDTO() + if include_optional: + return ServicingObjectconfigurationDimensionsChangeDefinitionsDTO( + dimensions_by_tenant = [ + visier_platform_sdk.models.servicing/objectconfiguration/dimension_change_definitions_by_tenant_dto.servicing.objectconfiguration.DimensionChangeDefinitionsByTenantDTO( + tenant_code = '', + project_id = '', + dimensions = [ + visier_platform_sdk.models.servicing/objectconfiguration/dimension_change_definition_dto.servicing.objectconfiguration.DimensionChangeDefinitionDTO( + id = '', + display_name = '', + short_display_name = '', + description = '', ) + ], ) + ] + ) + else: + return ServicingObjectconfigurationDimensionsChangeDefinitionsDTO( + ) + """ + + def testServicingObjectconfigurationDimensionsChangeDefinitionsDTO(self): + """Test ServicingObjectconfigurationDimensionsChangeDefinitionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_object_change_failure_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_object_change_failure_dto.py new file mode 100644 index 0000000000..d1bdcf927f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_object_change_failure_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_object_change_failure_dto import ServicingObjectconfigurationObjectChangeFailureDTO + +class TestServicingObjectconfigurationObjectChangeFailureDTO(unittest.TestCase): + """ServicingObjectconfigurationObjectChangeFailureDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationObjectChangeFailureDTO: + """Test ServicingObjectconfigurationObjectChangeFailureDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationObjectChangeFailureDTO` + """ + model = ServicingObjectconfigurationObjectChangeFailureDTO() + if include_optional: + return ServicingObjectconfigurationObjectChangeFailureDTO( + id = '', + display_name = '', + message = '', + rci = '', + tenant_code = '', + project_id = '' + ) + else: + return ServicingObjectconfigurationObjectChangeFailureDTO( + ) + """ + + def testServicingObjectconfigurationObjectChangeFailureDTO(self): + """Test ServicingObjectconfigurationObjectChangeFailureDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_object_change_success_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_object_change_success_dto.py new file mode 100644 index 0000000000..681569c1f5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_object_change_success_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_object_change_success_dto import ServicingObjectconfigurationObjectChangeSuccessDTO + +class TestServicingObjectconfigurationObjectChangeSuccessDTO(unittest.TestCase): + """ServicingObjectconfigurationObjectChangeSuccessDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationObjectChangeSuccessDTO: + """Test ServicingObjectconfigurationObjectChangeSuccessDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationObjectChangeSuccessDTO` + """ + model = ServicingObjectconfigurationObjectChangeSuccessDTO() + if include_optional: + return ServicingObjectconfigurationObjectChangeSuccessDTO( + id = '', + display_name = '', + tenant_code = '', + project_id = '' + ) + else: + return ServicingObjectconfigurationObjectChangeSuccessDTO( + ) + """ + + def testServicingObjectconfigurationObjectChangeSuccessDTO(self): + """Test ServicingObjectconfigurationObjectChangeSuccessDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_objects_bulk_change_response_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_objects_bulk_change_response_dto.py new file mode 100644 index 0000000000..4f9150118e --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_objects_bulk_change_response_dto.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_objects_bulk_change_response_dto import ServicingObjectconfigurationObjectsBulkChangeResponseDTO + +class TestServicingObjectconfigurationObjectsBulkChangeResponseDTO(unittest.TestCase): + """ServicingObjectconfigurationObjectsBulkChangeResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationObjectsBulkChangeResponseDTO: + """Test ServicingObjectconfigurationObjectsBulkChangeResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationObjectsBulkChangeResponseDTO` + """ + model = ServicingObjectconfigurationObjectsBulkChangeResponseDTO() + if include_optional: + return ServicingObjectconfigurationObjectsBulkChangeResponseDTO( + successes = [ + visier_platform_sdk.models.servicing/objectconfiguration/object_change_success_dto.servicing.objectconfiguration.ObjectChangeSuccessDTO( + id = '', + display_name = '', + tenant_code = '', + project_id = '', ) + ], + failures = [ + visier_platform_sdk.models.servicing/objectconfiguration/object_change_failure_dto.servicing.objectconfiguration.ObjectChangeFailureDTO( + id = '', + display_name = '', + message = '', + rci = '', + tenant_code = '', + project_id = '', ) + ] + ) + else: + return ServicingObjectconfigurationObjectsBulkChangeResponseDTO( + ) + """ + + def testServicingObjectconfigurationObjectsBulkChangeResponseDTO(self): + """Test ServicingObjectconfigurationObjectsBulkChangeResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_properties_change_definitions_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_properties_change_definitions_dto.py new file mode 100644 index 0000000000..bf2d18f7b0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_properties_change_definitions_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_properties_change_definitions_dto import ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + +class TestServicingObjectconfigurationPropertiesChangeDefinitionsDTO(unittest.TestCase): + """ServicingObjectconfigurationPropertiesChangeDefinitionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationPropertiesChangeDefinitionsDTO: + """Test ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationPropertiesChangeDefinitionsDTO` + """ + model = ServicingObjectconfigurationPropertiesChangeDefinitionsDTO() + if include_optional: + return ServicingObjectconfigurationPropertiesChangeDefinitionsDTO( + properties_by_tenant = [ + visier_platform_sdk.models.servicing/objectconfiguration/property_change_definitions_by_tenant_dto.servicing.objectconfiguration.PropertyChangeDefinitionsByTenantDTO( + tenant_code = '', + project_id = '', + properties = [ + visier_platform_sdk.models.servicing/objectconfiguration/property_change_definition_dto.servicing.objectconfiguration.PropertyChangeDefinitionDTO( + id = '', + display_name = '', + short_display_name = '', + description = '', + explanation = '', + designer_notes = '', + type = None, + tags = None, + include_with_vee = True, ) + ], ) + ] + ) + else: + return ServicingObjectconfigurationPropertiesChangeDefinitionsDTO( + ) + """ + + def testServicingObjectconfigurationPropertiesChangeDefinitionsDTO(self): + """Test ServicingObjectconfigurationPropertiesChangeDefinitionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_properties_delete_definitions_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_properties_delete_definitions_dto.py new file mode 100644 index 0000000000..e11bc51c6c --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_properties_delete_definitions_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_properties_delete_definitions_dto import ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO + +class TestServicingObjectconfigurationPropertiesDeleteDefinitionsDTO(unittest.TestCase): + """ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO: + """Test ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO` + """ + model = ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO() + if include_optional: + return ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO( + delete_derived_properties = True, + ignore_property_references = True, + properties_by_tenant = [ + visier_platform_sdk.models.servicing/objectconfiguration/property_delete_definitions_by_tenant_dto.servicing.objectconfiguration.PropertyDeleteDefinitionsByTenantDTO( + tenant_code = '', + project_id = '', + property_ids = [ + '' + ], ) + ] + ) + else: + return ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO( + ) + """ + + def testServicingObjectconfigurationPropertiesDeleteDefinitionsDTO(self): + """Test ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_bulk_delete_response_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_bulk_delete_response_dto.py new file mode 100644 index 0000000000..3b68d24ff8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_bulk_delete_response_dto.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_property_bulk_delete_response_dto import ServicingObjectconfigurationPropertyBulkDeleteResponseDTO + +class TestServicingObjectconfigurationPropertyBulkDeleteResponseDTO(unittest.TestCase): + """ServicingObjectconfigurationPropertyBulkDeleteResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationPropertyBulkDeleteResponseDTO: + """Test ServicingObjectconfigurationPropertyBulkDeleteResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationPropertyBulkDeleteResponseDTO` + """ + model = ServicingObjectconfigurationPropertyBulkDeleteResponseDTO() + if include_optional: + return ServicingObjectconfigurationPropertyBulkDeleteResponseDTO( + successes = [ + visier_platform_sdk.models.servicing/objectconfiguration/property_delete_success_dto.servicing.objectconfiguration.PropertyDeleteSuccessDTO( + id = '', + display_name = '', + tenant_code = '', + project_id = '', + derived_dependents_deleted = [ + visier_platform_sdk.models.servicing/objectconfiguration/dependent_dto.servicing.objectconfiguration.DependentDTO( + id = '', + display_name = '', + object_type = '', ) + ], + reference_dependents_ignored = [ + visier_platform_sdk.models.servicing/objectconfiguration/dependent_dto.servicing.objectconfiguration.DependentDTO( + id = '', + display_name = '', + object_type = '', ) + ], ) + ], + failures = [ + visier_platform_sdk.models.servicing/objectconfiguration/property_delete_failure_dto.servicing.objectconfiguration.PropertyDeleteFailureDTO( + id = '', + display_name = '', + message = '', + rci = '', + tenant_code = '', + project_id = '', + derived_dependents_to_delete = [ + visier_platform_sdk.models.servicing/objectconfiguration/dependent_dto.servicing.objectconfiguration.DependentDTO( + id = '', + display_name = '', + object_type = '', ) + ], + reference_dependents_to_ignore = [ + visier_platform_sdk.models.servicing/objectconfiguration/dependent_dto.servicing.objectconfiguration.DependentDTO( + id = '', + display_name = '', + object_type = '', ) + ], ) + ] + ) + else: + return ServicingObjectconfigurationPropertyBulkDeleteResponseDTO( + ) + """ + + def testServicingObjectconfigurationPropertyBulkDeleteResponseDTO(self): + """Test ServicingObjectconfigurationPropertyBulkDeleteResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_change_definition_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_change_definition_dto.py new file mode 100644 index 0000000000..24da83f0d7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_change_definition_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_property_change_definition_dto import ServicingObjectconfigurationPropertyChangeDefinitionDTO + +class TestServicingObjectconfigurationPropertyChangeDefinitionDTO(unittest.TestCase): + """ServicingObjectconfigurationPropertyChangeDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationPropertyChangeDefinitionDTO: + """Test ServicingObjectconfigurationPropertyChangeDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationPropertyChangeDefinitionDTO` + """ + model = ServicingObjectconfigurationPropertyChangeDefinitionDTO() + if include_optional: + return ServicingObjectconfigurationPropertyChangeDefinitionDTO( + id = '', + display_name = '', + short_display_name = '', + description = '', + explanation = '', + designer_notes = '', + type = visier_platform_sdk.models.servicing/objectconfiguration/property_type_dto.servicing.objectconfiguration.PropertyTypeDTO( + simple = None, + calculated = None, ), + tags = visier_platform_sdk.models.servicing/objectconfiguration/tags_dto.servicing.objectconfiguration.TagsDTO( + ids = [ + '' + ], ), + include_with_vee = True + ) + else: + return ServicingObjectconfigurationPropertyChangeDefinitionDTO( + ) + """ + + def testServicingObjectconfigurationPropertyChangeDefinitionDTO(self): + """Test ServicingObjectconfigurationPropertyChangeDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_change_definitions_by_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_change_definitions_by_tenant_dto.py new file mode 100644 index 0000000000..e2f9c34db5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_change_definitions_by_tenant_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_property_change_definitions_by_tenant_dto import ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO + +class TestServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO(unittest.TestCase): + """ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO: + """Test ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO` + """ + model = ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO() + if include_optional: + return ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO( + tenant_code = '', + project_id = '', + properties = [ + visier_platform_sdk.models.servicing/objectconfiguration/property_change_definition_dto.servicing.objectconfiguration.PropertyChangeDefinitionDTO( + id = '', + display_name = '', + short_display_name = '', + description = '', + explanation = '', + designer_notes = '', + type = None, + tags = None, + include_with_vee = True, ) + ] + ) + else: + return ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO( + ) + """ + + def testServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO(self): + """Test ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_delete_definitions_by_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_delete_definitions_by_tenant_dto.py new file mode 100644 index 0000000000..b8e4b56c35 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_delete_definitions_by_tenant_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_definitions_by_tenant_dto import ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO + +class TestServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO(unittest.TestCase): + """ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO: + """Test ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO` + """ + model = ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO() + if include_optional: + return ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO( + tenant_code = '', + project_id = '', + property_ids = [ + '' + ] + ) + else: + return ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO( + ) + """ + + def testServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO(self): + """Test ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_delete_failure_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_delete_failure_dto.py new file mode 100644 index 0000000000..45f050fae2 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_delete_failure_dto.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_failure_dto import ServicingObjectconfigurationPropertyDeleteFailureDTO + +class TestServicingObjectconfigurationPropertyDeleteFailureDTO(unittest.TestCase): + """ServicingObjectconfigurationPropertyDeleteFailureDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationPropertyDeleteFailureDTO: + """Test ServicingObjectconfigurationPropertyDeleteFailureDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationPropertyDeleteFailureDTO` + """ + model = ServicingObjectconfigurationPropertyDeleteFailureDTO() + if include_optional: + return ServicingObjectconfigurationPropertyDeleteFailureDTO( + id = '', + display_name = '', + message = '', + rci = '', + tenant_code = '', + project_id = '', + derived_dependents_to_delete = [ + visier_platform_sdk.models.servicing/objectconfiguration/dependent_dto.servicing.objectconfiguration.DependentDTO( + id = '', + display_name = '', + object_type = '', ) + ], + reference_dependents_to_ignore = [ + visier_platform_sdk.models.servicing/objectconfiguration/dependent_dto.servicing.objectconfiguration.DependentDTO( + id = '', + display_name = '', + object_type = '', ) + ] + ) + else: + return ServicingObjectconfigurationPropertyDeleteFailureDTO( + ) + """ + + def testServicingObjectconfigurationPropertyDeleteFailureDTO(self): + """Test ServicingObjectconfigurationPropertyDeleteFailureDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_delete_success_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_delete_success_dto.py new file mode 100644 index 0000000000..3a2bef09ba --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_delete_success_dto.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_success_dto import ServicingObjectconfigurationPropertyDeleteSuccessDTO + +class TestServicingObjectconfigurationPropertyDeleteSuccessDTO(unittest.TestCase): + """ServicingObjectconfigurationPropertyDeleteSuccessDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationPropertyDeleteSuccessDTO: + """Test ServicingObjectconfigurationPropertyDeleteSuccessDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationPropertyDeleteSuccessDTO` + """ + model = ServicingObjectconfigurationPropertyDeleteSuccessDTO() + if include_optional: + return ServicingObjectconfigurationPropertyDeleteSuccessDTO( + id = '', + display_name = '', + tenant_code = '', + project_id = '', + derived_dependents_deleted = [ + visier_platform_sdk.models.servicing/objectconfiguration/dependent_dto.servicing.objectconfiguration.DependentDTO( + id = '', + display_name = '', + object_type = '', ) + ], + reference_dependents_ignored = [ + visier_platform_sdk.models.servicing/objectconfiguration/dependent_dto.servicing.objectconfiguration.DependentDTO( + id = '', + display_name = '', + object_type = '', ) + ] + ) + else: + return ServicingObjectconfigurationPropertyDeleteSuccessDTO( + ) + """ + + def testServicingObjectconfigurationPropertyDeleteSuccessDTO(self): + """Test ServicingObjectconfigurationPropertyDeleteSuccessDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_type_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_type_dto.py new file mode 100644 index 0000000000..7d54e5bd3f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_property_type_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_property_type_dto import ServicingObjectconfigurationPropertyTypeDTO + +class TestServicingObjectconfigurationPropertyTypeDTO(unittest.TestCase): + """ServicingObjectconfigurationPropertyTypeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationPropertyTypeDTO: + """Test ServicingObjectconfigurationPropertyTypeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationPropertyTypeDTO` + """ + model = ServicingObjectconfigurationPropertyTypeDTO() + if include_optional: + return ServicingObjectconfigurationPropertyTypeDTO( + simple = visier_platform_sdk.models.servicing/objectconfiguration/simple_property_type_dto.servicing.objectconfiguration.SimplePropertyTypeDTO( + data_type = '', ), + calculated = visier_platform_sdk.models.servicing/objectconfiguration/calculated_property_type_dto.servicing.objectconfiguration.CalculatedPropertyTypeDTO( + data_type = '', + formula = '', ) + ) + else: + return ServicingObjectconfigurationPropertyTypeDTO( + ) + """ + + def testServicingObjectconfigurationPropertyTypeDTO(self): + """Test ServicingObjectconfigurationPropertyTypeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_simple_property_type_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_simple_property_type_dto.py new file mode 100644 index 0000000000..38d1aaa4d4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_simple_property_type_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_simple_property_type_dto import ServicingObjectconfigurationSimplePropertyTypeDTO + +class TestServicingObjectconfigurationSimplePropertyTypeDTO(unittest.TestCase): + """ServicingObjectconfigurationSimplePropertyTypeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationSimplePropertyTypeDTO: + """Test ServicingObjectconfigurationSimplePropertyTypeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationSimplePropertyTypeDTO` + """ + model = ServicingObjectconfigurationSimplePropertyTypeDTO() + if include_optional: + return ServicingObjectconfigurationSimplePropertyTypeDTO( + data_type = '' + ) + else: + return ServicingObjectconfigurationSimplePropertyTypeDTO( + ) + """ + + def testServicingObjectconfigurationSimplePropertyTypeDTO(self): + """Test ServicingObjectconfigurationSimplePropertyTypeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_objectconfiguration_tags_dto.py b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_tags_dto.py new file mode 100644 index 0000000000..45813c59ca --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_objectconfiguration_tags_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_objectconfiguration_tags_dto import ServicingObjectconfigurationTagsDTO + +class TestServicingObjectconfigurationTagsDTO(unittest.TestCase): + """ServicingObjectconfigurationTagsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingObjectconfigurationTagsDTO: + """Test ServicingObjectconfigurationTagsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingObjectconfigurationTagsDTO` + """ + model = ServicingObjectconfigurationTagsDTO() + if include_optional: + return ServicingObjectconfigurationTagsDTO( + ids = [ + '' + ] + ) + else: + return ServicingObjectconfigurationTagsDTO( + ) + """ + + def testServicingObjectconfigurationTagsDTO(self): + """Test ServicingObjectconfigurationTagsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_permission_assigned_by_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_permission_assigned_by_tenant_dto.py new file mode 100644 index 0000000000..decccfe6c5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_permission_assigned_by_tenant_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_permission_assigned_by_tenant_dto import ServicingPermissionAssignedByTenantDTO + +class TestServicingPermissionAssignedByTenantDTO(unittest.TestCase): + """ServicingPermissionAssignedByTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPermissionAssignedByTenantDTO: + """Test ServicingPermissionAssignedByTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPermissionAssignedByTenantDTO` + """ + model = ServicingPermissionAssignedByTenantDTO() + if include_optional: + return ServicingPermissionAssignedByTenantDTO( + tenant_code = '', + users = [ + visier_platform_sdk.models.servicing/permission_assigned_user_dto.servicing.PermissionAssignedUserDTO( + user_id = '', + username = '', + permission_from = '', ) + ] + ) + else: + return ServicingPermissionAssignedByTenantDTO( + ) + """ + + def testServicingPermissionAssignedByTenantDTO(self): + """Test ServicingPermissionAssignedByTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_permission_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_permission_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..279ee78522 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_permission_assigned_for_local_tenant_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_permission_assigned_for_local_tenant_dto import ServicingPermissionAssignedForLocalTenantDTO + +class TestServicingPermissionAssignedForLocalTenantDTO(unittest.TestCase): + """ServicingPermissionAssignedForLocalTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPermissionAssignedForLocalTenantDTO: + """Test ServicingPermissionAssignedForLocalTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPermissionAssignedForLocalTenantDTO` + """ + model = ServicingPermissionAssignedForLocalTenantDTO() + if include_optional: + return ServicingPermissionAssignedForLocalTenantDTO( + permission_id = '', + display_name = '', + description = '' + ) + else: + return ServicingPermissionAssignedForLocalTenantDTO( + ) + """ + + def testServicingPermissionAssignedForLocalTenantDTO(self): + """Test ServicingPermissionAssignedForLocalTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_permission_assigned_user_dto.py b/src/visier_platform_sdk/test/test_servicing_permission_assigned_user_dto.py new file mode 100644 index 0000000000..4517255bf8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_permission_assigned_user_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_permission_assigned_user_dto import ServicingPermissionAssignedUserDTO + +class TestServicingPermissionAssignedUserDTO(unittest.TestCase): + """ServicingPermissionAssignedUserDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPermissionAssignedUserDTO: + """Test ServicingPermissionAssignedUserDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPermissionAssignedUserDTO` + """ + model = ServicingPermissionAssignedUserDTO() + if include_optional: + return ServicingPermissionAssignedUserDTO( + user_id = '', + username = '', + permission_from = '' + ) + else: + return ServicingPermissionAssignedUserDTO( + ) + """ + + def testServicingPermissionAssignedUserDTO(self): + """Test ServicingPermissionAssignedUserDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_permission_assigned_users_dto.py b/src/visier_platform_sdk/test/test_servicing_permission_assigned_users_dto.py new file mode 100644 index 0000000000..a26b0cb5d8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_permission_assigned_users_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_permission_assigned_users_dto import ServicingPermissionAssignedUsersDTO + +class TestServicingPermissionAssignedUsersDTO(unittest.TestCase): + """ServicingPermissionAssignedUsersDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPermissionAssignedUsersDTO: + """Test ServicingPermissionAssignedUsersDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPermissionAssignedUsersDTO` + """ + model = ServicingPermissionAssignedUsersDTO() + if include_optional: + return ServicingPermissionAssignedUsersDTO( + tenants = [ + visier_platform_sdk.models.servicing/permission_assigned_by_tenant_dto.servicing.PermissionAssignedByTenantDTO( + tenant_code = '', + users = [ + visier_platform_sdk.models.servicing/permission_assigned_user_dto.servicing.PermissionAssignedUserDTO( + user_id = '', + username = '', + permission_from = '', ) + ], ) + ], + limit = 56, + start = 56 + ) + else: + return ServicingPermissionAssignedUsersDTO( + ) + """ + + def testServicingPermissionAssignedUsersDTO(self): + """Test ServicingPermissionAssignedUsersDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_permission_bulk_operation_response_dto.py b/src/visier_platform_sdk/test/test_servicing_permission_bulk_operation_response_dto.py new file mode 100644 index 0000000000..6328abb75c --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_permission_bulk_operation_response_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_permission_bulk_operation_response_dto import ServicingPermissionBulkOperationResponseDTO + +class TestServicingPermissionBulkOperationResponseDTO(unittest.TestCase): + """ServicingPermissionBulkOperationResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPermissionBulkOperationResponseDTO: + """Test ServicingPermissionBulkOperationResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPermissionBulkOperationResponseDTO` + """ + model = ServicingPermissionBulkOperationResponseDTO() + if include_optional: + return ServicingPermissionBulkOperationResponseDTO( + successes = [ + visier_platform_sdk.models.servicing/permission_success_dto.servicing.PermissionSuccessDTO( + permission_id = '', + display_name = '', ) + ], + failures = [ + visier_platform_sdk.models.servicing/permission_failure_dto.servicing.PermissionFailureDTO( + permission_id = '', + display_name = '', + error = None, ) + ] + ) + else: + return ServicingPermissionBulkOperationResponseDTO( + ) + """ + + def testServicingPermissionBulkOperationResponseDTO(self): + """Test ServicingPermissionBulkOperationResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_permission_dto.py b/src/visier_platform_sdk/test/test_servicing_permission_dto.py new file mode 100644 index 0000000000..4974dae8dc --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_permission_dto.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_permission_dto import ServicingPermissionDTO + +class TestServicingPermissionDTO(unittest.TestCase): + """ServicingPermissionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPermissionDTO: + """Test ServicingPermissionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPermissionDTO` + """ + model = ServicingPermissionDTO() + if include_optional: + return ServicingPermissionDTO( + permission_id = '', + display_name = '', + description = '', + data_security_profiles = [ + visier_platform_sdk.models.servicing/data_security_profile_dto.servicing.DataSecurityProfileDTO( + analytic_object_id = '', + property_set_config = None, + all_data_point_access = True, + member_filter_configs = [ + visier_platform_sdk.models.servicing/member_filter_config_dto.servicing.MemberFilterConfigDTO( + dimension_filters = [ + visier_platform_sdk.models.servicing/dimension_filter_dto.servicing.DimensionFilterDTO( + static_dimension_filter = visier_platform_sdk.models.servicing/static_dimension_filter_dto.servicing.StaticDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + member_selections = [ + visier_platform_sdk.models.servicing/member_selection_dto.servicing.MemberSelectionDTO( + name_path = [ + '' + ], + excluded = True, + dimension_member_status = 'Unset', ) + ], + dimension_status = 'Unset', ), + dynamic_dimension_filter = visier_platform_sdk.models.servicing/dynamic_dimension_filter_dto.servicing.DynamicDimensionFilterDTO( + dimension_id = '', + dynamic_property_mappings = [ + visier_platform_sdk.models.servicing/dynamic_property_mapping_dto.servicing.DynamicPropertyMappingDTO( + hierarchy_property_id = '', + user_property = None, + hierarchy_property_status = 'Unset', ) + ], + dimension_status = 'Unset', ), ) + ], ) + ], + inherited_access_configs = [ + visier_platform_sdk.models.servicing/inherited_access_config_dto.servicing.InheritedAccessConfigDTO( + analytic_object_id = '', + remove_access = True, ) + ], + inherited_reference_member_filter_config = None, + analytic_object_status = 'Unset', ) + ], + admin_capability_config = visier_platform_sdk.models.servicing/admin_capability_config_dto.servicing.AdminCapabilityConfigDTO( + all_capabilities_access = True, + capabilities = [ + '' + ], ), + role_modules_config = visier_platform_sdk.models.servicing/role_modules_config_dto.servicing.RoleModulesConfigDTO( + content_package_ids = [ + '' + ], ) + ) + else: + return ServicingPermissionDTO( + ) + """ + + def testServicingPermissionDTO(self): + """Test ServicingPermissionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_permission_error_dto.py b/src/visier_platform_sdk/test/test_servicing_permission_error_dto.py new file mode 100644 index 0000000000..c7b413dbfb --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_permission_error_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_permission_error_dto import ServicingPermissionErrorDTO + +class TestServicingPermissionErrorDTO(unittest.TestCase): + """ServicingPermissionErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPermissionErrorDTO: + """Test ServicingPermissionErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPermissionErrorDTO` + """ + model = ServicingPermissionErrorDTO() + if include_optional: + return ServicingPermissionErrorDTO( + message = '', + rci = '' + ) + else: + return ServicingPermissionErrorDTO( + ) + """ + + def testServicingPermissionErrorDTO(self): + """Test ServicingPermissionErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_permission_failure_dto.py b/src/visier_platform_sdk/test/test_servicing_permission_failure_dto.py new file mode 100644 index 0000000000..7f753dede6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_permission_failure_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_permission_failure_dto import ServicingPermissionFailureDTO + +class TestServicingPermissionFailureDTO(unittest.TestCase): + """ServicingPermissionFailureDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPermissionFailureDTO: + """Test ServicingPermissionFailureDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPermissionFailureDTO` + """ + model = ServicingPermissionFailureDTO() + if include_optional: + return ServicingPermissionFailureDTO( + permission_id = '', + display_name = '', + error = visier_platform_sdk.models.servicing/permission_error_dto.servicing.PermissionErrorDTO( + message = '', + rci = '', ) + ) + else: + return ServicingPermissionFailureDTO( + ) + """ + + def testServicingPermissionFailureDTO(self): + """Test ServicingPermissionFailureDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_permission_success_dto.py b/src/visier_platform_sdk/test/test_servicing_permission_success_dto.py new file mode 100644 index 0000000000..8584256c93 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_permission_success_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_permission_success_dto import ServicingPermissionSuccessDTO + +class TestServicingPermissionSuccessDTO(unittest.TestCase): + """ServicingPermissionSuccessDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPermissionSuccessDTO: + """Test ServicingPermissionSuccessDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPermissionSuccessDTO` + """ + model = ServicingPermissionSuccessDTO() + if include_optional: + return ServicingPermissionSuccessDTO( + permission_id = '', + display_name = '' + ) + else: + return ServicingPermissionSuccessDTO( + ) + """ + + def testServicingPermissionSuccessDTO(self): + """Test ServicingPermissionSuccessDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_production_version_api_operation_request_dto.py b/src/visier_platform_sdk/test/test_servicing_production_version_api_operation_request_dto.py new file mode 100644 index 0000000000..5774503863 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_production_version_api_operation_request_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_production_version_api_operation_request_dto import ServicingProductionVersionAPIOperationRequestDTO + +class TestServicingProductionVersionAPIOperationRequestDTO(unittest.TestCase): + """ServicingProductionVersionAPIOperationRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProductionVersionAPIOperationRequestDTO: + """Test ServicingProductionVersionAPIOperationRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProductionVersionAPIOperationRequestDTO` + """ + model = ServicingProductionVersionAPIOperationRequestDTO() + if include_optional: + return ServicingProductionVersionAPIOperationRequestDTO( + operation = 'unknownProductionVersionAPIOperation' + ) + else: + return ServicingProductionVersionAPIOperationRequestDTO( + ) + """ + + def testServicingProductionVersionAPIOperationRequestDTO(self): + """Test ServicingProductionVersionAPIOperationRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_production_version_api_operation_response_dto.py b/src/visier_platform_sdk/test/test_servicing_production_version_api_operation_response_dto.py new file mode 100644 index 0000000000..80668967e7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_production_version_api_operation_response_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_production_version_api_operation_response_dto import ServicingProductionVersionAPIOperationResponseDTO + +class TestServicingProductionVersionAPIOperationResponseDTO(unittest.TestCase): + """ServicingProductionVersionAPIOperationResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProductionVersionAPIOperationResponseDTO: + """Test ServicingProductionVersionAPIOperationResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProductionVersionAPIOperationResponseDTO` + """ + model = ServicingProductionVersionAPIOperationResponseDTO() + if include_optional: + return ServicingProductionVersionAPIOperationResponseDTO( + roll_back_to = visier_platform_sdk.models.servicing/project_dto.servicing.ProjectDTO( + id = '', + name = '', + description = '', + release_version = '', + ticket_number = '', + version_number = 56, + capabilities = [ + 'canRead' + ], ) + ) + else: + return ServicingProductionVersionAPIOperationResponseDTO( + ) + """ + + def testServicingProductionVersionAPIOperationResponseDTO(self): + """Test ServicingProductionVersionAPIOperationResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_production_versions_api_operation_request_dto.py b/src/visier_platform_sdk/test/test_servicing_production_versions_api_operation_request_dto.py new file mode 100644 index 0000000000..e7fbde0806 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_production_versions_api_operation_request_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_production_versions_api_operation_request_dto import ServicingProductionVersionsAPIOperationRequestDTO + +class TestServicingProductionVersionsAPIOperationRequestDTO(unittest.TestCase): + """ServicingProductionVersionsAPIOperationRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProductionVersionsAPIOperationRequestDTO: + """Test ServicingProductionVersionsAPIOperationRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProductionVersionsAPIOperationRequestDTO` + """ + model = ServicingProductionVersionsAPIOperationRequestDTO() + if include_optional: + return ServicingProductionVersionsAPIOperationRequestDTO( + operation = 'unknownProductionVersionsAPIOperation', + export_parameters = visier_platform_sdk.models.servicing/export_production_versions_api_operation_parameters_dto.servicing.ExportProductionVersionsAPIOperationParametersDTO( + start_version = '', + end_version = '', + excluded_versions = [ + '' + ], ) + ) + else: + return ServicingProductionVersionsAPIOperationRequestDTO( + ) + """ + + def testServicingProductionVersionsAPIOperationRequestDTO(self): + """Test ServicingProductionVersionsAPIOperationRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_production_versions_api_operation_response_dto.py b/src/visier_platform_sdk/test/test_servicing_production_versions_api_operation_response_dto.py new file mode 100644 index 0000000000..fcfba111db --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_production_versions_api_operation_response_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_production_versions_api_operation_response_dto import ServicingProductionVersionsAPIOperationResponseDTO + +class TestServicingProductionVersionsAPIOperationResponseDTO(unittest.TestCase): + """ServicingProductionVersionsAPIOperationResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProductionVersionsAPIOperationResponseDTO: + """Test ServicingProductionVersionsAPIOperationResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProductionVersionsAPIOperationResponseDTO` + """ + model = ServicingProductionVersionsAPIOperationResponseDTO() + if include_optional: + return ServicingProductionVersionsAPIOperationResponseDTO( + export = None + ) + else: + return ServicingProductionVersionsAPIOperationResponseDTO( + ) + """ + + def testServicingProductionVersionsAPIOperationResponseDTO(self): + """Test ServicingProductionVersionsAPIOperationResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_profile_assigned_for_accessible_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_profile_assigned_for_accessible_tenant_dto.py new file mode 100644 index 0000000000..9103403b09 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_profile_assigned_for_accessible_tenant_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_profile_assigned_for_accessible_tenant_dto import ServicingProfileAssignedForAccessibleTenantDTO + +class TestServicingProfileAssignedForAccessibleTenantDTO(unittest.TestCase): + """ServicingProfileAssignedForAccessibleTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProfileAssignedForAccessibleTenantDTO: + """Test ServicingProfileAssignedForAccessibleTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProfileAssignedForAccessibleTenantDTO` + """ + model = ServicingProfileAssignedForAccessibleTenantDTO() + if include_optional: + return ServicingProfileAssignedForAccessibleTenantDTO( + profile_id = '', + display_name = '', + tenant_code = '', + for_all_children = True, + validity_start_time = '', + validity_end_time = '' + ) + else: + return ServicingProfileAssignedForAccessibleTenantDTO( + ) + """ + + def testServicingProfileAssignedForAccessibleTenantDTO(self): + """Test ServicingProfileAssignedForAccessibleTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_profile_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_profile_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..90727ef679 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_profile_assigned_for_local_tenant_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_profile_assigned_for_local_tenant_dto import ServicingProfileAssignedForLocalTenantDTO + +class TestServicingProfileAssignedForLocalTenantDTO(unittest.TestCase): + """ServicingProfileAssignedForLocalTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProfileAssignedForLocalTenantDTO: + """Test ServicingProfileAssignedForLocalTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProfileAssignedForLocalTenantDTO` + """ + model = ServicingProfileAssignedForLocalTenantDTO() + if include_optional: + return ServicingProfileAssignedForLocalTenantDTO( + profile_id = '', + display_name = '', + validity_start_time = '', + validity_end_time = '', + capabilities = [ + visier_platform_sdk.models.servicing/capabilities_dto.servicing.CapabilitiesDTO( + capability = '', + access_level = '', + view_level = '', ) + ], + additional_capabilities = visier_platform_sdk.models.servicing/additional_capabilities_dto.servicing.AdditionalCapabilitiesDTO( + additional_capabilities = [ + '' + ], ) + ) + else: + return ServicingProfileAssignedForLocalTenantDTO( + ) + """ + + def testServicingProfileAssignedForLocalTenantDTO(self): + """Test ServicingProfileAssignedForLocalTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_profile_get_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_profile_get_api_response_dto.py new file mode 100644 index 0000000000..6ab75a2206 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_profile_get_api_response_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_profile_get_api_response_dto import ServicingProfileGetAPIResponseDTO + +class TestServicingProfileGetAPIResponseDTO(unittest.TestCase): + """ServicingProfileGetAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProfileGetAPIResponseDTO: + """Test ServicingProfileGetAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProfileGetAPIResponseDTO` + """ + model = ServicingProfileGetAPIResponseDTO() + if include_optional: + return ServicingProfileGetAPIResponseDTO( + profile_id = '', + display_name = '', + capabilities = [ + visier_platform_sdk.models.servicing/capabilities_dto.servicing.CapabilitiesDTO( + capability = '', + access_level = '', + view_level = '', ) + ], + additional_capabilities = [ + '' + ] + ) + else: + return ServicingProfileGetAPIResponseDTO( + ) + """ + + def testServicingProfileGetAPIResponseDTO(self): + """Test ServicingProfileGetAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_profiles_get_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_profiles_get_api_response_dto.py new file mode 100644 index 0000000000..80509b3577 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_profiles_get_api_response_dto.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_profiles_get_api_response_dto import ServicingProfilesGetAPIResponseDTO + +class TestServicingProfilesGetAPIResponseDTO(unittest.TestCase): + """ServicingProfilesGetAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProfilesGetAPIResponseDTO: + """Test ServicingProfilesGetAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProfilesGetAPIResponseDTO` + """ + model = ServicingProfilesGetAPIResponseDTO() + if include_optional: + return ServicingProfilesGetAPIResponseDTO( + profiles = [ + visier_platform_sdk.models.servicing/profile_get_api_response_dto.servicing.ProfileGetAPIResponseDTO( + profile_id = '', + display_name = '', + capabilities = [ + visier_platform_sdk.models.servicing/capabilities_dto.servicing.CapabilitiesDTO( + capability = '', + access_level = '', + view_level = '', ) + ], + additional_capabilities = [ + '' + ], ) + ] + ) + else: + return ServicingProfilesGetAPIResponseDTO( + ) + """ + + def testServicingProfilesGetAPIResponseDTO(self): + """Test ServicingProfilesGetAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_project_commits_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_project_commits_api_response_dto.py new file mode 100644 index 0000000000..9495ea560d --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_project_commits_api_response_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_project_commits_api_response_dto import ServicingProjectCommitsAPIResponseDTO + +class TestServicingProjectCommitsAPIResponseDTO(unittest.TestCase): + """ServicingProjectCommitsAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProjectCommitsAPIResponseDTO: + """Test ServicingProjectCommitsAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProjectCommitsAPIResponseDTO` + """ + model = ServicingProjectCommitsAPIResponseDTO() + if include_optional: + return ServicingProjectCommitsAPIResponseDTO( + commits = [ + visier_platform_sdk.models.servicing/commit_dto.servicing.CommitDTO( + id = '', + name = '', + description = '', ) + ] + ) + else: + return ServicingProjectCommitsAPIResponseDTO( + ) + """ + + def testServicingProjectCommitsAPIResponseDTO(self): + """Test ServicingProjectCommitsAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_project_dto.py b/src/visier_platform_sdk/test/test_servicing_project_dto.py new file mode 100644 index 0000000000..dc8f8b8bd9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_project_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_project_dto import ServicingProjectDTO + +class TestServicingProjectDTO(unittest.TestCase): + """ServicingProjectDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProjectDTO: + """Test ServicingProjectDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProjectDTO` + """ + model = ServicingProjectDTO() + if include_optional: + return ServicingProjectDTO( + id = '', + name = '', + description = '', + release_version = '', + ticket_number = '', + version_number = 56, + capabilities = [ + 'canRead' + ] + ) + else: + return ServicingProjectDTO( + ) + """ + + def testServicingProjectDTO(self): + """Test ServicingProjectDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_project_operation_request_dto.py b/src/visier_platform_sdk/test/test_servicing_project_operation_request_dto.py new file mode 100644 index 0000000000..d291b370ca --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_project_operation_request_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_project_operation_request_dto import ServicingProjectOperationRequestDTO + +class TestServicingProjectOperationRequestDTO(unittest.TestCase): + """ServicingProjectOperationRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProjectOperationRequestDTO: + """Test ServicingProjectOperationRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProjectOperationRequestDTO` + """ + model = ServicingProjectOperationRequestDTO() + if include_optional: + return ServicingProjectOperationRequestDTO( + operation = 'unknown' + ) + else: + return ServicingProjectOperationRequestDTO( + ) + """ + + def testServicingProjectOperationRequestDTO(self): + """Test ServicingProjectOperationRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_project_operation_response_dto.py b/src/visier_platform_sdk/test/test_servicing_project_operation_response_dto.py new file mode 100644 index 0000000000..d22bd2767f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_project_operation_response_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_project_operation_response_dto import ServicingProjectOperationResponseDTO + +class TestServicingProjectOperationResponseDTO(unittest.TestCase): + """ServicingProjectOperationResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingProjectOperationResponseDTO: + """Test ServicingProjectOperationResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingProjectOperationResponseDTO` + """ + model = ServicingProjectOperationResponseDTO() + if include_optional: + return ServicingProjectOperationResponseDTO( + commit_and_publish = visier_platform_sdk.models.servicing/commit_and_publish_operation_response_dto.servicing.CommitAndPublishOperationResponseDTO( + published_version = None, ) + ) + else: + return ServicingProjectOperationResponseDTO( + ) + """ + + def testServicingProjectOperationResponseDTO(self): + """Test ServicingProjectOperationResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_property_access_config_dto.py b/src/visier_platform_sdk/test/test_servicing_property_access_config_dto.py new file mode 100644 index 0000000000..b3fde9e8e9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_property_access_config_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_property_access_config_dto import ServicingPropertyAccessConfigDTO + +class TestServicingPropertyAccessConfigDTO(unittest.TestCase): + """ServicingPropertyAccessConfigDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPropertyAccessConfigDTO: + """Test ServicingPropertyAccessConfigDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPropertyAccessConfigDTO` + """ + model = ServicingPropertyAccessConfigDTO() + if include_optional: + return ServicingPropertyAccessConfigDTO( + property_id = '', + analytic_object_id = '', + analytic_object_reference_paths = [ + '' + ], + access_level = 'None', + property_status = 'Unset' + ) + else: + return ServicingPropertyAccessConfigDTO( + ) + """ + + def testServicingPropertyAccessConfigDTO(self): + """Test ServicingPropertyAccessConfigDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_property_set_config_dto.py b/src/visier_platform_sdk/test/test_servicing_property_set_config_dto.py new file mode 100644 index 0000000000..a8183c5d94 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_property_set_config_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_property_set_config_dto import ServicingPropertySetConfigDTO + +class TestServicingPropertySetConfigDTO(unittest.TestCase): + """ServicingPropertySetConfigDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingPropertySetConfigDTO: + """Test ServicingPropertySetConfigDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingPropertySetConfigDTO` + """ + model = ServicingPropertySetConfigDTO() + if include_optional: + return ServicingPropertySetConfigDTO( + property_access_configs = [ + visier_platform_sdk.models.servicing/property_access_config_dto.servicing.PropertyAccessConfigDTO( + property_id = '', + analytic_object_id = '', + analytic_object_reference_paths = [ + '' + ], + access_level = 'None', + property_status = 'Unset', ) + ], + shareable_data_access_set = visier_platform_sdk.models.servicing/shareable_data_access_set.servicing.ShareableDataAccessSet( + data_access_set_id = '', ) + ) + else: + return ServicingPropertySetConfigDTO( + ) + """ + + def testServicingPropertySetConfigDTO(self): + """Test ServicingPropertySetConfigDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_question_categories_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_question_categories_api_response_dto.py new file mode 100644 index 0000000000..4f754a7607 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_question_categories_api_response_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_question_categories_api_response_dto import ServicingQuestionCategoriesAPIResponseDTO + +class TestServicingQuestionCategoriesAPIResponseDTO(unittest.TestCase): + """ServicingQuestionCategoriesAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingQuestionCategoriesAPIResponseDTO: + """Test ServicingQuestionCategoriesAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingQuestionCategoriesAPIResponseDTO` + """ + model = ServicingQuestionCategoriesAPIResponseDTO() + if include_optional: + return ServicingQuestionCategoriesAPIResponseDTO( + categories = [ + visier_platform_sdk.models.servicing/question_category_api_response_dto.servicing.QuestionCategoryAPIResponseDTO( + category_id = '', + display_name = '', ) + ] + ) + else: + return ServicingQuestionCategoriesAPIResponseDTO( + ) + """ + + def testServicingQuestionCategoriesAPIResponseDTO(self): + """Test ServicingQuestionCategoriesAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_question_category_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_question_category_api_response_dto.py new file mode 100644 index 0000000000..65cc985ed1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_question_category_api_response_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_question_category_api_response_dto import ServicingQuestionCategoryAPIResponseDTO + +class TestServicingQuestionCategoryAPIResponseDTO(unittest.TestCase): + """ServicingQuestionCategoryAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingQuestionCategoryAPIResponseDTO: + """Test ServicingQuestionCategoryAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingQuestionCategoryAPIResponseDTO` + """ + model = ServicingQuestionCategoryAPIResponseDTO() + if include_optional: + return ServicingQuestionCategoryAPIResponseDTO( + category_id = '', + display_name = '' + ) + else: + return ServicingQuestionCategoryAPIResponseDTO( + ) + """ + + def testServicingQuestionCategoryAPIResponseDTO(self): + """Test ServicingQuestionCategoryAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_reduced_error_dto.py b/src/visier_platform_sdk/test/test_servicing_reduced_error_dto.py new file mode 100644 index 0000000000..f03a6d1c37 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_reduced_error_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_reduced_error_dto import ServicingReducedErrorDTO + +class TestServicingReducedErrorDTO(unittest.TestCase): + """ServicingReducedErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingReducedErrorDTO: + """Test ServicingReducedErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingReducedErrorDTO` + """ + model = ServicingReducedErrorDTO() + if include_optional: + return ServicingReducedErrorDTO( + error_message = '' + ) + else: + return ServicingReducedErrorDTO( + ) + """ + + def testServicingReducedErrorDTO(self): + """Test ServicingReducedErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_reduced_tenant_code_error_dto.py b/src/visier_platform_sdk/test/test_servicing_reduced_tenant_code_error_dto.py new file mode 100644 index 0000000000..54d1437be5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_reduced_tenant_code_error_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_reduced_tenant_code_error_dto import ServicingReducedTenantCodeErrorDTO + +class TestServicingReducedTenantCodeErrorDTO(unittest.TestCase): + """ServicingReducedTenantCodeErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingReducedTenantCodeErrorDTO: + """Test ServicingReducedTenantCodeErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingReducedTenantCodeErrorDTO` + """ + model = ServicingReducedTenantCodeErrorDTO() + if include_optional: + return ServicingReducedTenantCodeErrorDTO( + tenant_code = '', + for_all_children = True, + error = visier_platform_sdk.models.servicing/reduced_error_dto.servicing.ReducedErrorDTO( + error_message = '', ) + ) + else: + return ServicingReducedTenantCodeErrorDTO( + ) + """ + + def testServicingReducedTenantCodeErrorDTO(self): + """Test ServicingReducedTenantCodeErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_reduced_user_id_error_dto.py b/src/visier_platform_sdk/test/test_servicing_reduced_user_id_error_dto.py new file mode 100644 index 0000000000..d34da90ad1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_reduced_user_id_error_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_reduced_user_id_error_dto import ServicingReducedUserIdErrorDTO + +class TestServicingReducedUserIdErrorDTO(unittest.TestCase): + """ServicingReducedUserIdErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingReducedUserIdErrorDTO: + """Test ServicingReducedUserIdErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingReducedUserIdErrorDTO` + """ + model = ServicingReducedUserIdErrorDTO() + if include_optional: + return ServicingReducedUserIdErrorDTO( + user_id = '', + error = visier_platform_sdk.models.servicing/reduced_error_dto.servicing.ReducedErrorDTO( + error_message = '', ) + ) + else: + return ServicingReducedUserIdErrorDTO( + ) + """ + + def testServicingReducedUserIdErrorDTO(self): + """Test ServicingReducedUserIdErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_related_analytic_object_dto.py b/src/visier_platform_sdk/test/test_servicing_related_analytic_object_dto.py new file mode 100644 index 0000000000..fbae6e50ab --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_related_analytic_object_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_related_analytic_object_dto import ServicingRelatedAnalyticObjectDTO + +class TestServicingRelatedAnalyticObjectDTO(unittest.TestCase): + """ServicingRelatedAnalyticObjectDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingRelatedAnalyticObjectDTO: + """Test ServicingRelatedAnalyticObjectDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingRelatedAnalyticObjectDTO` + """ + model = ServicingRelatedAnalyticObjectDTO() + if include_optional: + return ServicingRelatedAnalyticObjectDTO( + analytic_object_id = '', + display_name = '' + ) + else: + return ServicingRelatedAnalyticObjectDTO( + ) + """ + + def testServicingRelatedAnalyticObjectDTO(self): + """Test ServicingRelatedAnalyticObjectDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_role_modules_config_dto.py b/src/visier_platform_sdk/test/test_servicing_role_modules_config_dto.py new file mode 100644 index 0000000000..286f612211 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_role_modules_config_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_role_modules_config_dto import ServicingRoleModulesConfigDTO + +class TestServicingRoleModulesConfigDTO(unittest.TestCase): + """ServicingRoleModulesConfigDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingRoleModulesConfigDTO: + """Test ServicingRoleModulesConfigDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingRoleModulesConfigDTO` + """ + model = ServicingRoleModulesConfigDTO() + if include_optional: + return ServicingRoleModulesConfigDTO( + content_package_ids = [ + '' + ] + ) + else: + return ServicingRoleModulesConfigDTO( + ) + """ + + def testServicingRoleModulesConfigDTO(self): + """Test ServicingRoleModulesConfigDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_sample_question_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_sample_question_api_response_dto.py new file mode 100644 index 0000000000..a980a05259 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_sample_question_api_response_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_sample_question_api_response_dto import ServicingSampleQuestionAPIResponseDTO + +class TestServicingSampleQuestionAPIResponseDTO(unittest.TestCase): + """ServicingSampleQuestionAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingSampleQuestionAPIResponseDTO: + """Test ServicingSampleQuestionAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingSampleQuestionAPIResponseDTO` + """ + model = ServicingSampleQuestionAPIResponseDTO() + if include_optional: + return ServicingSampleQuestionAPIResponseDTO( + question = '', + question_id = '', + visible_in_vee = True, + category_id = '', + user_group_assignment = visier_platform_sdk.models.servicing/user_group_assignment_dto.servicing.UserGroupAssignmentDTO( + user_group_ids = [ + '' + ], ) + ) + else: + return ServicingSampleQuestionAPIResponseDTO( + ) + """ + + def testServicingSampleQuestionAPIResponseDTO(self): + """Test ServicingSampleQuestionAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_sample_questions_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_sample_questions_api_response_dto.py new file mode 100644 index 0000000000..8684197e68 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_sample_questions_api_response_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_sample_questions_api_response_dto import ServicingSampleQuestionsAPIResponseDTO + +class TestServicingSampleQuestionsAPIResponseDTO(unittest.TestCase): + """ServicingSampleQuestionsAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingSampleQuestionsAPIResponseDTO: + """Test ServicingSampleQuestionsAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingSampleQuestionsAPIResponseDTO` + """ + model = ServicingSampleQuestionsAPIResponseDTO() + if include_optional: + return ServicingSampleQuestionsAPIResponseDTO( + questions = [ + visier_platform_sdk.models.servicing/sample_question_api_response_dto.servicing.SampleQuestionAPIResponseDTO( + question = '', + question_id = '', + visible_in_vee = True, + category_id = '', + user_group_assignment = None, ) + ] + ) + else: + return ServicingSampleQuestionsAPIResponseDTO( + ) + """ + + def testServicingSampleQuestionsAPIResponseDTO(self): + """Test ServicingSampleQuestionsAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_securable_dimension_dto.py b/src/visier_platform_sdk/test/test_servicing_securable_dimension_dto.py new file mode 100644 index 0000000000..a2ce40ee20 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_securable_dimension_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_securable_dimension_dto import ServicingSecurableDimensionDTO + +class TestServicingSecurableDimensionDTO(unittest.TestCase): + """ServicingSecurableDimensionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingSecurableDimensionDTO: + """Test ServicingSecurableDimensionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingSecurableDimensionDTO` + """ + model = ServicingSecurableDimensionDTO() + if include_optional: + return ServicingSecurableDimensionDTO( + dimension_id = '', + display_name = '', + analytic_object_ids = [ + '' + ], + hierarchy_properties = [ + visier_platform_sdk.models.servicing/hierarchy_property_dto.servicing.HierarchyPropertyDTO( + hierarchy_property_id = '', + display_name = '', ) + ] + ) + else: + return ServicingSecurableDimensionDTO( + ) + """ + + def testServicingSecurableDimensionDTO(self): + """Test ServicingSecurableDimensionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_securable_property_dto.py b/src/visier_platform_sdk/test/test_servicing_securable_property_dto.py new file mode 100644 index 0000000000..16ce06dabc --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_securable_property_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_securable_property_dto import ServicingSecurablePropertyDTO + +class TestServicingSecurablePropertyDTO(unittest.TestCase): + """ServicingSecurablePropertyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingSecurablePropertyDTO: + """Test ServicingSecurablePropertyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingSecurablePropertyDTO` + """ + model = ServicingSecurablePropertyDTO() + if include_optional: + return ServicingSecurablePropertyDTO( + property_id = '', + display_name = '', + analytic_object_id = '', + is_primary_key = True, + reference_symbol_name = '' + ) + else: + return ServicingSecurablePropertyDTO( + ) + """ + + def testServicingSecurablePropertyDTO(self): + """Test ServicingSecurablePropertyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_servicing_capability_proto_enum_access_lookup_dto.py b/src/visier_platform_sdk/test/test_servicing_servicing_capability_proto_enum_access_lookup_dto.py new file mode 100644 index 0000000000..7368de6793 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_servicing_capability_proto_enum_access_lookup_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_servicing_capability_proto_enum_access_lookup_dto import ServicingServicingCapabilityProtoEnumAccessLookupDTO + +class TestServicingServicingCapabilityProtoEnumAccessLookupDTO(unittest.TestCase): + """ServicingServicingCapabilityProtoEnumAccessLookupDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingServicingCapabilityProtoEnumAccessLookupDTO: + """Test ServicingServicingCapabilityProtoEnumAccessLookupDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingServicingCapabilityProtoEnumAccessLookupDTO` + """ + model = ServicingServicingCapabilityProtoEnumAccessLookupDTO() + if include_optional: + return ServicingServicingCapabilityProtoEnumAccessLookupDTO( + capability_groups = [ + visier_platform_sdk.models.servicing/capability_group_dto.servicing.CapabilityGroupDTO( + group = 'unknown', + access_level = 'NoAccess', + view_level = 'Simple', + api_access_level = 'NoAccess', + api_view_level = 'Simple', ) + ] + ) + else: + return ServicingServicingCapabilityProtoEnumAccessLookupDTO( + ) + """ + + def testServicingServicingCapabilityProtoEnumAccessLookupDTO(self): + """Test ServicingServicingCapabilityProtoEnumAccessLookupDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_shareable_data_access_set.py b/src/visier_platform_sdk/test/test_servicing_shareable_data_access_set.py new file mode 100644 index 0000000000..d36833e23c --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_shareable_data_access_set.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_shareable_data_access_set import ServicingShareableDataAccessSet + +class TestServicingShareableDataAccessSet(unittest.TestCase): + """ServicingShareableDataAccessSet unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingShareableDataAccessSet: + """Test ServicingShareableDataAccessSet + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingShareableDataAccessSet` + """ + model = ServicingShareableDataAccessSet() + if include_optional: + return ServicingShareableDataAccessSet( + data_access_set_id = '' + ) + else: + return ServicingShareableDataAccessSet( + ) + """ + + def testServicingShareableDataAccessSet(self): + """Test ServicingShareableDataAccessSet""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_simple_document_header_search_response_dto.py b/src/visier_platform_sdk/test/test_servicing_simple_document_header_search_response_dto.py new file mode 100644 index 0000000000..b8af670358 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_simple_document_header_search_response_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_simple_document_header_search_response_dto import ServicingSimpleDocumentHeaderSearchResponseDTO + +class TestServicingSimpleDocumentHeaderSearchResponseDTO(unittest.TestCase): + """ServicingSimpleDocumentHeaderSearchResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingSimpleDocumentHeaderSearchResponseDTO: + """Test ServicingSimpleDocumentHeaderSearchResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingSimpleDocumentHeaderSearchResponseDTO` + """ + model = ServicingSimpleDocumentHeaderSearchResponseDTO() + if include_optional: + return ServicingSimpleDocumentHeaderSearchResponseDTO( + document_headers = [ + visier_platform_sdk.models.servicing/simple_document_header_search_result_dto.servicing.SimpleDocumentHeaderSearchResultDTO( + display_name = '', + description = '', + relevance = 1.337, + view_link = None, ) + ] + ) + else: + return ServicingSimpleDocumentHeaderSearchResponseDTO( + ) + """ + + def testServicingSimpleDocumentHeaderSearchResponseDTO(self): + """Test ServicingSimpleDocumentHeaderSearchResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_simple_document_header_search_result_dto.py b/src/visier_platform_sdk/test/test_servicing_simple_document_header_search_result_dto.py new file mode 100644 index 0000000000..32ea248f7a --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_simple_document_header_search_result_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_simple_document_header_search_result_dto import ServicingSimpleDocumentHeaderSearchResultDTO + +class TestServicingSimpleDocumentHeaderSearchResultDTO(unittest.TestCase): + """ServicingSimpleDocumentHeaderSearchResultDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingSimpleDocumentHeaderSearchResultDTO: + """Test ServicingSimpleDocumentHeaderSearchResultDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingSimpleDocumentHeaderSearchResultDTO` + """ + model = ServicingSimpleDocumentHeaderSearchResultDTO() + if include_optional: + return ServicingSimpleDocumentHeaderSearchResultDTO( + display_name = '', + description = '', + relevance = 1.337, + view_link = visier_platform_sdk.models.servicing/document_search_link_dto.servicing.DocumentSearchLinkDTO( + href = '', + verb = '', ) + ) + else: + return ServicingSimpleDocumentHeaderSearchResultDTO( + ) + """ + + def testServicingSimpleDocumentHeaderSearchResultDTO(self): + """Test ServicingSimpleDocumentHeaderSearchResultDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_sources_api_operation_request_dto.py b/src/visier_platform_sdk/test/test_servicing_sources_api_operation_request_dto.py new file mode 100644 index 0000000000..e1d91bb4a9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_sources_api_operation_request_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_sources_api_operation_request_dto import ServicingSourcesAPIOperationRequestDTO + +class TestServicingSourcesAPIOperationRequestDTO(unittest.TestCase): + """ServicingSourcesAPIOperationRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingSourcesAPIOperationRequestDTO: + """Test ServicingSourcesAPIOperationRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingSourcesAPIOperationRequestDTO` + """ + model = ServicingSourcesAPIOperationRequestDTO() + if include_optional: + return ServicingSourcesAPIOperationRequestDTO( + operation = 'unknownSourcesAPIOperation' + ) + else: + return ServicingSourcesAPIOperationRequestDTO( + ) + """ + + def testServicingSourcesAPIOperationRequestDTO(self): + """Test ServicingSourcesAPIOperationRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_static_dimension_filter_dto.py b/src/visier_platform_sdk/test/test_servicing_static_dimension_filter_dto.py new file mode 100644 index 0000000000..5aa402cb00 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_static_dimension_filter_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_static_dimension_filter_dto import ServicingStaticDimensionFilterDTO + +class TestServicingStaticDimensionFilterDTO(unittest.TestCase): + """ServicingStaticDimensionFilterDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingStaticDimensionFilterDTO: + """Test ServicingStaticDimensionFilterDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingStaticDimensionFilterDTO` + """ + model = ServicingStaticDimensionFilterDTO() + if include_optional: + return ServicingStaticDimensionFilterDTO( + dimension_id = '', + subject_reference_path = [ + '' + ], + member_selections = [ + visier_platform_sdk.models.servicing/member_selection_dto.servicing.MemberSelectionDTO( + name_path = [ + '' + ], + excluded = True, + dimension_member_status = 'Unset', ) + ], + dimension_status = 'Unset' + ) + else: + return ServicingStaticDimensionFilterDTO( + ) + """ + + def testServicingStaticDimensionFilterDTO(self): + """Test ServicingStaticDimensionFilterDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_successful_accessible_tenant_profile_assignment_dto.py b/src/visier_platform_sdk/test/test_servicing_successful_accessible_tenant_profile_assignment_dto.py new file mode 100644 index 0000000000..8e179408d7 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_successful_accessible_tenant_profile_assignment_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_successful_accessible_tenant_profile_assignment_dto import ServicingSuccessfulAccessibleTenantProfileAssignmentDTO + +class TestServicingSuccessfulAccessibleTenantProfileAssignmentDTO(unittest.TestCase): + """ServicingSuccessfulAccessibleTenantProfileAssignmentDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingSuccessfulAccessibleTenantProfileAssignmentDTO: + """Test ServicingSuccessfulAccessibleTenantProfileAssignmentDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingSuccessfulAccessibleTenantProfileAssignmentDTO` + """ + model = ServicingSuccessfulAccessibleTenantProfileAssignmentDTO() + if include_optional: + return ServicingSuccessfulAccessibleTenantProfileAssignmentDTO( + user_id = '', + tenant_code = '', + for_all_children = True + ) + else: + return ServicingSuccessfulAccessibleTenantProfileAssignmentDTO( + ) + """ + + def testServicingSuccessfulAccessibleTenantProfileAssignmentDTO(self): + """Test ServicingSuccessfulAccessibleTenantProfileAssignmentDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_successful_local_tenant_profile_assignment_dto.py b/src/visier_platform_sdk/test/test_servicing_successful_local_tenant_profile_assignment_dto.py new file mode 100644 index 0000000000..5d4631797a --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_successful_local_tenant_profile_assignment_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_successful_local_tenant_profile_assignment_dto import ServicingSuccessfulLocalTenantProfileAssignmentDTO + +class TestServicingSuccessfulLocalTenantProfileAssignmentDTO(unittest.TestCase): + """ServicingSuccessfulLocalTenantProfileAssignmentDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingSuccessfulLocalTenantProfileAssignmentDTO: + """Test ServicingSuccessfulLocalTenantProfileAssignmentDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingSuccessfulLocalTenantProfileAssignmentDTO` + """ + model = ServicingSuccessfulLocalTenantProfileAssignmentDTO() + if include_optional: + return ServicingSuccessfulLocalTenantProfileAssignmentDTO( + user_id = '' + ) + else: + return ServicingSuccessfulLocalTenantProfileAssignmentDTO( + ) + """ + + def testServicingSuccessfulLocalTenantProfileAssignmentDTO(self): + """Test ServicingSuccessfulLocalTenantProfileAssignmentDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_target_tenant_code_dto.py b/src/visier_platform_sdk/test/test_servicing_target_tenant_code_dto.py new file mode 100644 index 0000000000..7a0771e1cb --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_target_tenant_code_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_target_tenant_code_dto import ServicingTargetTenantCodeDTO + +class TestServicingTargetTenantCodeDTO(unittest.TestCase): + """ServicingTargetTenantCodeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingTargetTenantCodeDTO: + """Test ServicingTargetTenantCodeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingTargetTenantCodeDTO` + """ + model = ServicingTargetTenantCodeDTO() + if include_optional: + return ServicingTargetTenantCodeDTO( + tenant_code = '', + for_all_children = True + ) + else: + return ServicingTargetTenantCodeDTO( + ) + """ + + def testServicingTargetTenantCodeDTO(self): + """Test ServicingTargetTenantCodeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_tenant_code_error_dto.py b/src/visier_platform_sdk/test/test_servicing_tenant_code_error_dto.py new file mode 100644 index 0000000000..a4c65b8383 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_tenant_code_error_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_tenant_code_error_dto import ServicingTenantCodeErrorDTO + +class TestServicingTenantCodeErrorDTO(unittest.TestCase): + """ServicingTenantCodeErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingTenantCodeErrorDTO: + """Test ServicingTenantCodeErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingTenantCodeErrorDTO` + """ + model = ServicingTenantCodeErrorDTO() + if include_optional: + return ServicingTenantCodeErrorDTO( + tenant_code = '', + for_all_children = True, + error = visier_platform_sdk.models.servicing/error_dto.servicing.ErrorDTO( + root_cause_id = '', + error_code = '', + error_message = '', ) + ) + else: + return ServicingTenantCodeErrorDTO( + ) + """ + + def testServicingTenantCodeErrorDTO(self): + """Test ServicingTenantCodeErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_tenant_data_upload_status_response_dto.py b/src/visier_platform_sdk/test/test_servicing_tenant_data_upload_status_response_dto.py new file mode 100644 index 0000000000..5eb6099719 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_tenant_data_upload_status_response_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_tenant_data_upload_status_response_dto import ServicingTenantDataUploadStatusResponseDTO + +class TestServicingTenantDataUploadStatusResponseDTO(unittest.TestCase): + """ServicingTenantDataUploadStatusResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingTenantDataUploadStatusResponseDTO: + """Test ServicingTenantDataUploadStatusResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingTenantDataUploadStatusResponseDTO` + """ + model = ServicingTenantDataUploadStatusResponseDTO() + if include_optional: + return ServicingTenantDataUploadStatusResponseDTO( + upload_time = '', + included = True + ) + else: + return ServicingTenantDataUploadStatusResponseDTO( + ) + """ + + def testServicingTenantDataUploadStatusResponseDTO(self): + """Test ServicingTenantDataUploadStatusResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_tenant_data_upload_update_status_response_dto.py b/src/visier_platform_sdk/test/test_servicing_tenant_data_upload_update_status_response_dto.py new file mode 100644 index 0000000000..47fef6f893 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_tenant_data_upload_update_status_response_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_tenant_data_upload_update_status_response_dto import ServicingTenantDataUploadUpdateStatusResponseDTO + +class TestServicingTenantDataUploadUpdateStatusResponseDTO(unittest.TestCase): + """ServicingTenantDataUploadUpdateStatusResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingTenantDataUploadUpdateStatusResponseDTO: + """Test ServicingTenantDataUploadUpdateStatusResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingTenantDataUploadUpdateStatusResponseDTO` + """ + model = ServicingTenantDataUploadUpdateStatusResponseDTO() + if include_optional: + return ServicingTenantDataUploadUpdateStatusResponseDTO( + tenant_code = '', + upload_time = '', + status = '', + message = '' + ) + else: + return ServicingTenantDataUploadUpdateStatusResponseDTO( + ) + """ + + def testServicingTenantDataUploadUpdateStatusResponseDTO(self): + """Test ServicingTenantDataUploadUpdateStatusResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_tenant_data_uploads_list_response_dto.py b/src/visier_platform_sdk/test/test_servicing_tenant_data_uploads_list_response_dto.py new file mode 100644 index 0000000000..02e027686c --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_tenant_data_uploads_list_response_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_tenant_data_uploads_list_response_dto import ServicingTenantDataUploadsListResponseDTO + +class TestServicingTenantDataUploadsListResponseDTO(unittest.TestCase): + """ServicingTenantDataUploadsListResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingTenantDataUploadsListResponseDTO: + """Test ServicingTenantDataUploadsListResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingTenantDataUploadsListResponseDTO` + """ + model = ServicingTenantDataUploadsListResponseDTO() + if include_optional: + return ServicingTenantDataUploadsListResponseDTO( + tenants = [ + visier_platform_sdk.models.servicing/tenant_data_uploads_response_dto.servicing.TenantDataUploadsResponseDTO( + tenant_code = '', + uploads = [ + visier_platform_sdk.models.servicing/tenant_data_upload_status_response_dto.servicing.TenantDataUploadStatusResponseDTO( + upload_time = '', + included = True, ) + ], ) + ], + limit = 56, + start = 56 + ) + else: + return ServicingTenantDataUploadsListResponseDTO( + ) + """ + + def testServicingTenantDataUploadsListResponseDTO(self): + """Test ServicingTenantDataUploadsListResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_tenant_data_uploads_response_dto.py b/src/visier_platform_sdk/test/test_servicing_tenant_data_uploads_response_dto.py new file mode 100644 index 0000000000..c4bf72036b --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_tenant_data_uploads_response_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_tenant_data_uploads_response_dto import ServicingTenantDataUploadsResponseDTO + +class TestServicingTenantDataUploadsResponseDTO(unittest.TestCase): + """ServicingTenantDataUploadsResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingTenantDataUploadsResponseDTO: + """Test ServicingTenantDataUploadsResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingTenantDataUploadsResponseDTO` + """ + model = ServicingTenantDataUploadsResponseDTO() + if include_optional: + return ServicingTenantDataUploadsResponseDTO( + tenant_code = '', + uploads = [ + visier_platform_sdk.models.servicing/tenant_data_upload_status_response_dto.servicing.TenantDataUploadStatusResponseDTO( + upload_time = '', + included = True, ) + ] + ) + else: + return ServicingTenantDataUploadsResponseDTO( + ) + """ + + def testServicingTenantDataUploadsResponseDTO(self): + """Test ServicingTenantDataUploadsResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_tenant_data_uploads_update_response_dto.py b/src/visier_platform_sdk/test/test_servicing_tenant_data_uploads_update_response_dto.py new file mode 100644 index 0000000000..ecbe0cd92d --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_tenant_data_uploads_update_response_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_tenant_data_uploads_update_response_dto import ServicingTenantDataUploadsUpdateResponseDTO + +class TestServicingTenantDataUploadsUpdateResponseDTO(unittest.TestCase): + """ServicingTenantDataUploadsUpdateResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingTenantDataUploadsUpdateResponseDTO: + """Test ServicingTenantDataUploadsUpdateResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingTenantDataUploadsUpdateResponseDTO` + """ + model = ServicingTenantDataUploadsUpdateResponseDTO() + if include_optional: + return ServicingTenantDataUploadsUpdateResponseDTO( + total_failures = 56, + total_success = 56, + uploads = [ + visier_platform_sdk.models.servicing/tenant_data_upload_update_status_response_dto.servicing.TenantDataUploadUpdateStatusResponseDTO( + tenant_code = '', + upload_time = '', + status = '', + message = '', ) + ] + ) + else: + return ServicingTenantDataUploadsUpdateResponseDTO( + ) + """ + + def testServicingTenantDataUploadsUpdateResponseDTO(self): + """Test ServicingTenantDataUploadsUpdateResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_user_creation_api_request_dto.py b/src/visier_platform_sdk/test/test_servicing_user_creation_api_request_dto.py new file mode 100644 index 0000000000..a12b064999 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_user_creation_api_request_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_user_creation_api_request_dto import ServicingUserCreationAPIRequestDTO + +class TestServicingUserCreationAPIRequestDTO(unittest.TestCase): + """ServicingUserCreationAPIRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUserCreationAPIRequestDTO: + """Test ServicingUserCreationAPIRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUserCreationAPIRequestDTO` + """ + model = ServicingUserCreationAPIRequestDTO() + if include_optional: + return ServicingUserCreationAPIRequestDTO( + username = '', + display_name = '', + employee_id = '', + account_enabled = '', + email = '' + ) + else: + return ServicingUserCreationAPIRequestDTO( + ) + """ + + def testServicingUserCreationAPIRequestDTO(self): + """Test ServicingUserCreationAPIRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_user_get_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_user_get_api_response_dto.py new file mode 100644 index 0000000000..1d0216b8f3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_user_get_api_response_dto.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_user_get_api_response_dto import ServicingUserGetAPIResponseDTO + +class TestServicingUserGetAPIResponseDTO(unittest.TestCase): + """ServicingUserGetAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUserGetAPIResponseDTO: + """Test ServicingUserGetAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUserGetAPIResponseDTO` + """ + model = ServicingUserGetAPIResponseDTO() + if include_optional: + return ServicingUserGetAPIResponseDTO( + user_id = '', + username = '', + display_name = '', + employee_id = '', + account_enabled = True, + profiles = visier_platform_sdk.models.servicing/all_profile_assigned_for_local_tenant_dto.servicing.AllProfileAssignedForLocalTenantDTO( + assigned_profiles = [ + visier_platform_sdk.models.servicing/profile_assigned_for_local_tenant_dto.servicing.ProfileAssignedForLocalTenantDTO( + profile_id = '', + display_name = '', + validity_start_time = '', + validity_end_time = '', + capabilities = [ + visier_platform_sdk.models.servicing/capabilities_dto.servicing.CapabilitiesDTO( + capability = '', + access_level = '', + view_level = '', ) + ], + additional_capabilities = None, ) + ], ), + permissions = visier_platform_sdk.models.servicing/all_permissions_assigned_for_local_tenant_dto.servicing.AllPermissionsAssignedForLocalTenantDTO( + assigned_permissions = [ + visier_platform_sdk.models.servicing/permission_assigned_for_local_tenant_dto.servicing.PermissionAssignedForLocalTenantDTO( + permission_id = '', + display_name = '', + description = '', ) + ], ), + user_groups = visier_platform_sdk.models.servicing/all_user_groups_assigned_for_local_tenant_dto.servicing.AllUserGroupsAssignedForLocalTenantDTO( + assigned_user_groups = [ + visier_platform_sdk.models.servicing/user_group_assigned_for_local_tenant_dto.servicing.UserGroupAssignedForLocalTenantDTO( + user_group_id = '', + display_name = '', ) + ], ), + last_login = visier_platform_sdk.models.servicing/last_login_dto.servicing.LastLoginDTO( + timestamp = '', ), + email = '' + ) + else: + return ServicingUserGetAPIResponseDTO( + ) + """ + + def testServicingUserGetAPIResponseDTO(self): + """Test ServicingUserGetAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_user_group_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_user_group_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..47fc357390 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_user_group_assigned_for_local_tenant_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_user_group_assigned_for_local_tenant_dto import ServicingUserGroupAssignedForLocalTenantDTO + +class TestServicingUserGroupAssignedForLocalTenantDTO(unittest.TestCase): + """ServicingUserGroupAssignedForLocalTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUserGroupAssignedForLocalTenantDTO: + """Test ServicingUserGroupAssignedForLocalTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUserGroupAssignedForLocalTenantDTO` + """ + model = ServicingUserGroupAssignedForLocalTenantDTO() + if include_optional: + return ServicingUserGroupAssignedForLocalTenantDTO( + user_group_id = '', + display_name = '' + ) + else: + return ServicingUserGroupAssignedForLocalTenantDTO( + ) + """ + + def testServicingUserGroupAssignedForLocalTenantDTO(self): + """Test ServicingUserGroupAssignedForLocalTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_user_group_assignment_dto.py b/src/visier_platform_sdk/test/test_servicing_user_group_assignment_dto.py new file mode 100644 index 0000000000..bd885a0625 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_user_group_assignment_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_user_group_assignment_dto import ServicingUserGroupAssignmentDTO + +class TestServicingUserGroupAssignmentDTO(unittest.TestCase): + """ServicingUserGroupAssignmentDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUserGroupAssignmentDTO: + """Test ServicingUserGroupAssignmentDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUserGroupAssignmentDTO` + """ + model = ServicingUserGroupAssignmentDTO() + if include_optional: + return ServicingUserGroupAssignmentDTO( + user_group_ids = [ + '' + ] + ) + else: + return ServicingUserGroupAssignmentDTO( + ) + """ + + def testServicingUserGroupAssignmentDTO(self): + """Test ServicingUserGroupAssignmentDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_user_id_error_dto.py b/src/visier_platform_sdk/test/test_servicing_user_id_error_dto.py new file mode 100644 index 0000000000..f64be702f4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_user_id_error_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_user_id_error_dto import ServicingUserIdErrorDTO + +class TestServicingUserIdErrorDTO(unittest.TestCase): + """ServicingUserIdErrorDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUserIdErrorDTO: + """Test ServicingUserIdErrorDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUserIdErrorDTO` + """ + model = ServicingUserIdErrorDTO() + if include_optional: + return ServicingUserIdErrorDTO( + user_id = '', + error = visier_platform_sdk.models.servicing/error_dto.servicing.ErrorDTO( + root_cause_id = '', + error_code = '', + error_message = '', ) + ) + else: + return ServicingUserIdErrorDTO( + ) + """ + + def testServicingUserIdErrorDTO(self): + """Test ServicingUserIdErrorDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_user_property_dto.py b/src/visier_platform_sdk/test/test_servicing_user_property_dto.py new file mode 100644 index 0000000000..67dcd2d284 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_user_property_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_user_property_dto import ServicingUserPropertyDTO + +class TestServicingUserPropertyDTO(unittest.TestCase): + """ServicingUserPropertyDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUserPropertyDTO: + """Test ServicingUserPropertyDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUserPropertyDTO` + """ + model = ServicingUserPropertyDTO() + if include_optional: + return ServicingUserPropertyDTO( + name = '' + ) + else: + return ServicingUserPropertyDTO( + ) + """ + + def testServicingUserPropertyDTO(self): + """Test ServicingUserPropertyDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_user_update_api_request_dto.py b/src/visier_platform_sdk/test/test_servicing_user_update_api_request_dto.py new file mode 100644 index 0000000000..63c8251cf4 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_user_update_api_request_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_user_update_api_request_dto import ServicingUserUpdateAPIRequestDTO + +class TestServicingUserUpdateAPIRequestDTO(unittest.TestCase): + """ServicingUserUpdateAPIRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUserUpdateAPIRequestDTO: + """Test ServicingUserUpdateAPIRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUserUpdateAPIRequestDTO` + """ + model = ServicingUserUpdateAPIRequestDTO() + if include_optional: + return ServicingUserUpdateAPIRequestDTO( + display_name = '', + employee_id = '', + account_enabled = '', + email = '', + username = '' + ) + else: + return ServicingUserUpdateAPIRequestDTO( + ) + """ + + def testServicingUserUpdateAPIRequestDTO(self): + """Test ServicingUserUpdateAPIRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_users_api_error_message_dto.py b/src/visier_platform_sdk/test/test_servicing_users_api_error_message_dto.py new file mode 100644 index 0000000000..a9a2cd0e8c --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_users_api_error_message_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_users_api_error_message_dto import ServicingUsersAPIErrorMessageDTO + +class TestServicingUsersAPIErrorMessageDTO(unittest.TestCase): + """ServicingUsersAPIErrorMessageDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUsersAPIErrorMessageDTO: + """Test ServicingUsersAPIErrorMessageDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUsersAPIErrorMessageDTO` + """ + model = ServicingUsersAPIErrorMessageDTO() + if include_optional: + return ServicingUsersAPIErrorMessageDTO( + message = '', + rci = '' + ) + else: + return ServicingUsersAPIErrorMessageDTO( + ) + """ + + def testServicingUsersAPIErrorMessageDTO(self): + """Test ServicingUsersAPIErrorMessageDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_users_api_failure_dto.py b/src/visier_platform_sdk/test/test_servicing_users_api_failure_dto.py new file mode 100644 index 0000000000..8df9e56492 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_users_api_failure_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_users_api_failure_dto import ServicingUsersAPIFailureDTO + +class TestServicingUsersAPIFailureDTO(unittest.TestCase): + """ServicingUsersAPIFailureDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUsersAPIFailureDTO: + """Test ServicingUsersAPIFailureDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUsersAPIFailureDTO` + """ + model = ServicingUsersAPIFailureDTO() + if include_optional: + return ServicingUsersAPIFailureDTO( + user_id = '', + user_name = '', + display_name = '', + error = visier_platform_sdk.models.servicing/users_api_error_message_dto.servicing.UsersAPIErrorMessageDTO( + message = '', + rci = '', ) + ) + else: + return ServicingUsersAPIFailureDTO( + ) + """ + + def testServicingUsersAPIFailureDTO(self): + """Test ServicingUsersAPIFailureDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_users_api_response_dto.py b/src/visier_platform_sdk/test/test_servicing_users_api_response_dto.py new file mode 100644 index 0000000000..e4eccfa7f1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_users_api_response_dto.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_users_api_response_dto import ServicingUsersAPIResponseDTO + +class TestServicingUsersAPIResponseDTO(unittest.TestCase): + """ServicingUsersAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUsersAPIResponseDTO: + """Test ServicingUsersAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUsersAPIResponseDTO` + """ + model = ServicingUsersAPIResponseDTO() + if include_optional: + return ServicingUsersAPIResponseDTO( + successes = [ + visier_platform_sdk.models.servicing/users_api_success_dto.servicing.UsersAPISuccessDTO( + user_id = '', + username = '', + display_name = '', + employee_id = '', + account_enabled = '', + email = '', ) + ], + failures = [ + visier_platform_sdk.models.servicing/users_api_failure_dto.servicing.UsersAPIFailureDTO( + user_id = '', + user_name = '', + display_name = '', + error = None, ) + ] + ) + else: + return ServicingUsersAPIResponseDTO( + ) + """ + + def testServicingUsersAPIResponseDTO(self): + """Test ServicingUsersAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_users_api_success_dto.py b/src/visier_platform_sdk/test/test_servicing_users_api_success_dto.py new file mode 100644 index 0000000000..724926f4eb --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_users_api_success_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_users_api_success_dto import ServicingUsersAPISuccessDTO + +class TestServicingUsersAPISuccessDTO(unittest.TestCase): + """ServicingUsersAPISuccessDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUsersAPISuccessDTO: + """Test ServicingUsersAPISuccessDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUsersAPISuccessDTO` + """ + model = ServicingUsersAPISuccessDTO() + if include_optional: + return ServicingUsersAPISuccessDTO( + user_id = '', + username = '', + display_name = '', + employee_id = '', + account_enabled = '', + email = '' + ) + else: + return ServicingUsersAPISuccessDTO( + ) + """ + + def testServicingUsersAPISuccessDTO(self): + """Test ServicingUsersAPISuccessDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_users_creation_api_request_dto.py b/src/visier_platform_sdk/test/test_servicing_users_creation_api_request_dto.py new file mode 100644 index 0000000000..5e5d7f61fe --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_users_creation_api_request_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_users_creation_api_request_dto import ServicingUsersCreationAPIRequestDTO + +class TestServicingUsersCreationAPIRequestDTO(unittest.TestCase): + """ServicingUsersCreationAPIRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUsersCreationAPIRequestDTO: + """Test ServicingUsersCreationAPIRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUsersCreationAPIRequestDTO` + """ + model = ServicingUsersCreationAPIRequestDTO() + if include_optional: + return ServicingUsersCreationAPIRequestDTO( + users = [ + visier_platform_sdk.models.servicing/user_creation_api_request_dto.servicing.UserCreationAPIRequestDTO( + username = '', + display_name = '', + employee_id = '', + account_enabled = '', + email = '', ) + ] + ) + else: + return ServicingUsersCreationAPIRequestDTO( + ) + """ + + def testServicingUsersCreationAPIRequestDTO(self): + """Test ServicingUsersCreationAPIRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_users_delete_api_request_dto.py b/src/visier_platform_sdk/test/test_servicing_users_delete_api_request_dto.py new file mode 100644 index 0000000000..00801481a8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_users_delete_api_request_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_users_delete_api_request_dto import ServicingUsersDeleteAPIRequestDTO + +class TestServicingUsersDeleteAPIRequestDTO(unittest.TestCase): + """ServicingUsersDeleteAPIRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUsersDeleteAPIRequestDTO: + """Test ServicingUsersDeleteAPIRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUsersDeleteAPIRequestDTO` + """ + model = ServicingUsersDeleteAPIRequestDTO() + if include_optional: + return ServicingUsersDeleteAPIRequestDTO( + user_ids = [ + '' + ] + ) + else: + return ServicingUsersDeleteAPIRequestDTO( + ) + """ + + def testServicingUsersDeleteAPIRequestDTO(self): + """Test ServicingUsersDeleteAPIRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_users_update_api_request_dto.py b/src/visier_platform_sdk/test/test_servicing_users_update_api_request_dto.py new file mode 100644 index 0000000000..50002c68d6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_users_update_api_request_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_users_update_api_request_dto import ServicingUsersUpdateAPIRequestDTO + +class TestServicingUsersUpdateAPIRequestDTO(unittest.TestCase): + """ServicingUsersUpdateAPIRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUsersUpdateAPIRequestDTO: + """Test ServicingUsersUpdateAPIRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUsersUpdateAPIRequestDTO` + """ + model = ServicingUsersUpdateAPIRequestDTO() + if include_optional: + return ServicingUsersUpdateAPIRequestDTO( + users = [ + visier_platform_sdk.models.servicing/users_update_api_user_dto.servicing.UsersUpdateAPIUserDTO( + user_id = '', + display_name = '', + employee_id = '', + account_enabled = '', + email = '', + username = '', ) + ] + ) + else: + return ServicingUsersUpdateAPIRequestDTO( + ) + """ + + def testServicingUsersUpdateAPIRequestDTO(self): + """Test ServicingUsersUpdateAPIRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_users_update_api_user_dto.py b/src/visier_platform_sdk/test/test_servicing_users_update_api_user_dto.py new file mode 100644 index 0000000000..51840f2017 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_users_update_api_user_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_users_update_api_user_dto import ServicingUsersUpdateAPIUserDTO + +class TestServicingUsersUpdateAPIUserDTO(unittest.TestCase): + """ServicingUsersUpdateAPIUserDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingUsersUpdateAPIUserDTO: + """Test ServicingUsersUpdateAPIUserDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingUsersUpdateAPIUserDTO` + """ + model = ServicingUsersUpdateAPIUserDTO() + if include_optional: + return ServicingUsersUpdateAPIUserDTO( + user_id = '', + display_name = '', + employee_id = '', + account_enabled = '', + email = '', + username = '' + ) + else: + return ServicingUsersUpdateAPIUserDTO( + ) + """ + + def testServicingUsersUpdateAPIUserDTO(self): + """Test ServicingUsersUpdateAPIUserDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_analytic_object_definition_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_analytic_object_definition_dto.py new file mode 100644 index 0000000000..73756b131d --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_analytic_object_definition_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_definition_dto import ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO + +class TestServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO: + """Test ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO` + """ + model = ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO() + if include_optional: + return ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO( + uuid = '', + object_name = '', + update_operation = 'unspecified' + ) + else: + return ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO( + ) + """ + + def testServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO(self): + """Test ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_analytic_object_request_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_analytic_object_request_dto.py new file mode 100644 index 0000000000..ca67ec4541 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_analytic_object_request_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_request_dto import ServicingV2ObjectconfigurationAnalyticObjectRequestDTO + +class TestServicingV2ObjectconfigurationAnalyticObjectRequestDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationAnalyticObjectRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationAnalyticObjectRequestDTO: + """Test ServicingV2ObjectconfigurationAnalyticObjectRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationAnalyticObjectRequestDTO` + """ + model = ServicingV2ObjectconfigurationAnalyticObjectRequestDTO() + if include_optional: + return ServicingV2ObjectconfigurationAnalyticObjectRequestDTO( + analytic_objects = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/analytic_object_with_context_dto.servicing.v2.objectconfiguration.AnalyticObjectWithContextDTO( + execution_context = None, + analytic_object = None, ) + ] + ) + else: + return ServicingV2ObjectconfigurationAnalyticObjectRequestDTO( + ) + """ + + def testServicingV2ObjectconfigurationAnalyticObjectRequestDTO(self): + """Test ServicingV2ObjectconfigurationAnalyticObjectRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_analytic_object_with_context_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_analytic_object_with_context_dto.py new file mode 100644 index 0000000000..5400b8b3e1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_analytic_object_with_context_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_with_context_dto import ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO + +class TestServicingV2ObjectconfigurationAnalyticObjectWithContextDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO: + """Test ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO` + """ + model = ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO() + if include_optional: + return ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO( + execution_context = visier_platform_sdk.models.servicing/v2/objectconfiguration/execution_context_dto.servicing.v2.objectconfiguration.ExecutionContextDTO( + tenant_code = '', + project_id = '', ), + analytic_object = visier_platform_sdk.models.servicing/v2/objectconfiguration/analytic_object_definition_dto.servicing.v2.objectconfiguration.AnalyticObjectDefinitionDTO( + uuid = '', + object_name = '', + update_operation = 'unspecified', ) + ) + else: + return ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO( + ) + """ + + def testServicingV2ObjectconfigurationAnalyticObjectWithContextDTO(self): + """Test ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_basic_information_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_basic_information_dto.py new file mode 100644 index 0000000000..016e7f2eed --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_basic_information_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_basic_information_dto import ServicingV2ObjectconfigurationBasicInformationDTO + +class TestServicingV2ObjectconfigurationBasicInformationDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationBasicInformationDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationBasicInformationDTO: + """Test ServicingV2ObjectconfigurationBasicInformationDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationBasicInformationDTO` + """ + model = ServicingV2ObjectconfigurationBasicInformationDTO() + if include_optional: + return ServicingV2ObjectconfigurationBasicInformationDTO( + display_name = '', + short_display_name = '', + description = '', + explanation = '', + designer_notes = '', + synonym_list = visier_platform_sdk.models.servicing/v2/objectconfiguration/synonym_list_dto.servicing.v2.objectconfiguration.SynonymListDTO( + synonyms = [ + '' + ], ) + ) + else: + return ServicingV2ObjectconfigurationBasicInformationDTO( + ) + """ + + def testServicingV2ObjectconfigurationBasicInformationDTO(self): + """Test ServicingV2ObjectconfigurationBasicInformationDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_bulk_change_response_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_bulk_change_response_dto.py new file mode 100644 index 0000000000..b9b6d514ba --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_bulk_change_response_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_bulk_change_response_dto import ServicingV2ObjectconfigurationBulkChangeResponseDTO + +class TestServicingV2ObjectconfigurationBulkChangeResponseDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationBulkChangeResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationBulkChangeResponseDTO: + """Test ServicingV2ObjectconfigurationBulkChangeResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationBulkChangeResponseDTO` + """ + model = ServicingV2ObjectconfigurationBulkChangeResponseDTO() + if include_optional: + return ServicingV2ObjectconfigurationBulkChangeResponseDTO( + successes = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/successful_change_dto.servicing.v2.objectconfiguration.SuccessfulChangeDTO( + execution_context = None, + object_name = '', + uuid = '', + display_name = '', ) + ], + failures = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/failed_change_dto.servicing.v2.objectconfiguration.FailedChangeDTO( + execution_context = None, + object_name = '', + uuid = '', + display_name = '', + messages = [ + '' + ], ) + ] + ) + else: + return ServicingV2ObjectconfigurationBulkChangeResponseDTO( + ) + """ + + def testServicingV2ObjectconfigurationBulkChangeResponseDTO(self): + """Test ServicingV2ObjectconfigurationBulkChangeResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_calculated_property_type_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_calculated_property_type_dto.py new file mode 100644 index 0000000000..9a873dc35d --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_calculated_property_type_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_calculated_property_type_dto import ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO + +class TestServicingV2ObjectconfigurationCalculatedPropertyTypeDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO: + """Test ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO` + """ + model = ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO() + if include_optional: + return ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO( + data_type = '', + primitive_type = '', + formula = '' + ) + else: + return ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO( + ) + """ + + def testServicingV2ObjectconfigurationCalculatedPropertyTypeDTO(self): + """Test ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_definition_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_definition_dto.py new file mode 100644 index 0000000000..b4de088a3a --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_definition_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_definition_dto import ServicingV2ObjectconfigurationConceptDefinitionDTO + +class TestServicingV2ObjectconfigurationConceptDefinitionDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationConceptDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationConceptDefinitionDTO: + """Test ServicingV2ObjectconfigurationConceptDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationConceptDefinitionDTO` + """ + model = ServicingV2ObjectconfigurationConceptDefinitionDTO() + if include_optional: + return ServicingV2ObjectconfigurationConceptDefinitionDTO( + uuid = '', + object_name = '', + basic_information = visier_platform_sdk.models.servicing/v2/objectconfiguration/basic_information_dto.servicing.v2.objectconfiguration.BasicInformationDTO( + display_name = '', + short_display_name = '', + description = '', + explanation = '', + designer_notes = '', + synonym_list = None, ), + details = visier_platform_sdk.models.servicing/v2/objectconfiguration/concept_type_details_dto.servicing.v2.objectconfiguration.ConceptTypeDetailsDTO( + process = None, ) + ) + else: + return ServicingV2ObjectconfigurationConceptDefinitionDTO( + ) + """ + + def testServicingV2ObjectconfigurationConceptDefinitionDTO(self): + """Test ServicingV2ObjectconfigurationConceptDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_delete_request_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_delete_request_dto.py new file mode 100644 index 0000000000..a4af68a5b9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_delete_request_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_delete_request_dto import ServicingV2ObjectconfigurationConceptDeleteRequestDTO + +class TestServicingV2ObjectconfigurationConceptDeleteRequestDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationConceptDeleteRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationConceptDeleteRequestDTO: + """Test ServicingV2ObjectconfigurationConceptDeleteRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationConceptDeleteRequestDTO` + """ + model = ServicingV2ObjectconfigurationConceptDeleteRequestDTO() + if include_optional: + return ServicingV2ObjectconfigurationConceptDeleteRequestDTO( + concepts = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/concept_delete_with_context_dto.servicing.v2.objectconfiguration.ConceptDeleteWithContextDTO( + execution_context = None, + concept = None, ) + ] + ) + else: + return ServicingV2ObjectconfigurationConceptDeleteRequestDTO( + ) + """ + + def testServicingV2ObjectconfigurationConceptDeleteRequestDTO(self): + """Test ServicingV2ObjectconfigurationConceptDeleteRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_delete_with_context_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_delete_with_context_dto.py new file mode 100644 index 0000000000..7bdc25ef7e --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_delete_with_context_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_delete_with_context_dto import ServicingV2ObjectconfigurationConceptDeleteWithContextDTO + +class TestServicingV2ObjectconfigurationConceptDeleteWithContextDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationConceptDeleteWithContextDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationConceptDeleteWithContextDTO: + """Test ServicingV2ObjectconfigurationConceptDeleteWithContextDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationConceptDeleteWithContextDTO` + """ + model = ServicingV2ObjectconfigurationConceptDeleteWithContextDTO() + if include_optional: + return ServicingV2ObjectconfigurationConceptDeleteWithContextDTO( + execution_context = visier_platform_sdk.models.servicing/v2/objectconfiguration/execution_context_dto.servicing.v2.objectconfiguration.ExecutionContextDTO( + tenant_code = '', + project_id = '', ), + concept = visier_platform_sdk.models.servicing/v2/objectconfiguration/object_id_dto.servicing.v2.objectconfiguration.ObjectIdDTO( + uuid = '', + object_name = '', ) + ) + else: + return ServicingV2ObjectconfigurationConceptDeleteWithContextDTO( + ) + """ + + def testServicingV2ObjectconfigurationConceptDeleteWithContextDTO(self): + """Test ServicingV2ObjectconfigurationConceptDeleteWithContextDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_request_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_request_dto.py new file mode 100644 index 0000000000..95cb624ce3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_request_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_request_dto import ServicingV2ObjectconfigurationConceptRequestDTO + +class TestServicingV2ObjectconfigurationConceptRequestDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationConceptRequestDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationConceptRequestDTO: + """Test ServicingV2ObjectconfigurationConceptRequestDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationConceptRequestDTO` + """ + model = ServicingV2ObjectconfigurationConceptRequestDTO() + if include_optional: + return ServicingV2ObjectconfigurationConceptRequestDTO( + concepts = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/concept_with_context_dto.servicing.v2.objectconfiguration.ConceptWithContextDTO( + execution_context = None, + concept = None, ) + ] + ) + else: + return ServicingV2ObjectconfigurationConceptRequestDTO( + ) + """ + + def testServicingV2ObjectconfigurationConceptRequestDTO(self): + """Test ServicingV2ObjectconfigurationConceptRequestDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_response_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_response_dto.py new file mode 100644 index 0000000000..34c982a890 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_response_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_response_dto import ServicingV2ObjectconfigurationConceptResponseDTO + +class TestServicingV2ObjectconfigurationConceptResponseDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationConceptResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationConceptResponseDTO: + """Test ServicingV2ObjectconfigurationConceptResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationConceptResponseDTO` + """ + model = ServicingV2ObjectconfigurationConceptResponseDTO() + if include_optional: + return ServicingV2ObjectconfigurationConceptResponseDTO( + concepts = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/concept_with_context_dto.servicing.v2.objectconfiguration.ConceptWithContextDTO( + execution_context = None, + concept = None, ) + ] + ) + else: + return ServicingV2ObjectconfigurationConceptResponseDTO( + ) + """ + + def testServicingV2ObjectconfigurationConceptResponseDTO(self): + """Test ServicingV2ObjectconfigurationConceptResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_type_details_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_type_details_dto.py new file mode 100644 index 0000000000..ec95000de1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_type_details_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_type_details_dto import ServicingV2ObjectconfigurationConceptTypeDetailsDTO + +class TestServicingV2ObjectconfigurationConceptTypeDetailsDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationConceptTypeDetailsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationConceptTypeDetailsDTO: + """Test ServicingV2ObjectconfigurationConceptTypeDetailsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationConceptTypeDetailsDTO` + """ + model = ServicingV2ObjectconfigurationConceptTypeDetailsDTO() + if include_optional: + return ServicingV2ObjectconfigurationConceptTypeDetailsDTO( + process = visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_definition_dto.servicing.v2.objectconfiguration.ProcessConceptDefinitionDTO( + analytic_object_name = '', + status_dimension_object_name = '', + participation_concept_uuid = '', + on_hold_concept_uuid = '', + stage_list = None, + outcome_list = None, + metric_list = None, + property_list = None, + tag_list = None, + visible_in_analytics = True, + include_with_vee = True, ) + ) + else: + return ServicingV2ObjectconfigurationConceptTypeDetailsDTO( + ) + """ + + def testServicingV2ObjectconfigurationConceptTypeDetailsDTO(self): + """Test ServicingV2ObjectconfigurationConceptTypeDetailsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_with_context_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_with_context_dto.py new file mode 100644 index 0000000000..33c29c796d --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_concept_with_context_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_with_context_dto import ServicingV2ObjectconfigurationConceptWithContextDTO + +class TestServicingV2ObjectconfigurationConceptWithContextDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationConceptWithContextDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationConceptWithContextDTO: + """Test ServicingV2ObjectconfigurationConceptWithContextDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationConceptWithContextDTO` + """ + model = ServicingV2ObjectconfigurationConceptWithContextDTO() + if include_optional: + return ServicingV2ObjectconfigurationConceptWithContextDTO( + execution_context = visier_platform_sdk.models.servicing/v2/objectconfiguration/execution_context_dto.servicing.v2.objectconfiguration.ExecutionContextDTO( + tenant_code = '', + project_id = '', ), + concept = visier_platform_sdk.models.servicing/v2/objectconfiguration/concept_definition_dto.servicing.v2.objectconfiguration.ConceptDefinitionDTO( + uuid = '', + object_name = '', + basic_information = None, + details = None, ) + ) + else: + return ServicingV2ObjectconfigurationConceptWithContextDTO( + ) + """ + + def testServicingV2ObjectconfigurationConceptWithContextDTO(self): + """Test ServicingV2ObjectconfigurationConceptWithContextDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_execution_context_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_execution_context_dto.py new file mode 100644 index 0000000000..df716a9344 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_execution_context_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_execution_context_dto import ServicingV2ObjectconfigurationExecutionContextDTO + +class TestServicingV2ObjectconfigurationExecutionContextDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationExecutionContextDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationExecutionContextDTO: + """Test ServicingV2ObjectconfigurationExecutionContextDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationExecutionContextDTO` + """ + model = ServicingV2ObjectconfigurationExecutionContextDTO() + if include_optional: + return ServicingV2ObjectconfigurationExecutionContextDTO( + tenant_code = '', + project_id = '' + ) + else: + return ServicingV2ObjectconfigurationExecutionContextDTO( + ) + """ + + def testServicingV2ObjectconfigurationExecutionContextDTO(self): + """Test ServicingV2ObjectconfigurationExecutionContextDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_failed_change_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_failed_change_dto.py new file mode 100644 index 0000000000..50cf8dd0a5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_failed_change_dto.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_failed_change_dto import ServicingV2ObjectconfigurationFailedChangeDTO + +class TestServicingV2ObjectconfigurationFailedChangeDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationFailedChangeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationFailedChangeDTO: + """Test ServicingV2ObjectconfigurationFailedChangeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationFailedChangeDTO` + """ + model = ServicingV2ObjectconfigurationFailedChangeDTO() + if include_optional: + return ServicingV2ObjectconfigurationFailedChangeDTO( + execution_context = visier_platform_sdk.models.servicing/v2/objectconfiguration/execution_context_dto.servicing.v2.objectconfiguration.ExecutionContextDTO( + tenant_code = '', + project_id = '', ), + object_name = '', + uuid = '', + display_name = '', + messages = [ + '' + ] + ) + else: + return ServicingV2ObjectconfigurationFailedChangeDTO( + ) + """ + + def testServicingV2ObjectconfigurationFailedChangeDTO(self): + """Test ServicingV2ObjectconfigurationFailedChangeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_metric_definition_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_metric_definition_dto.py new file mode 100644 index 0000000000..483eeaaa1e --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_metric_definition_dto.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_metric_definition_dto import ServicingV2ObjectconfigurationMetricDefinitionDTO + +class TestServicingV2ObjectconfigurationMetricDefinitionDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationMetricDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationMetricDefinitionDTO: + """Test ServicingV2ObjectconfigurationMetricDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationMetricDefinitionDTO` + """ + model = ServicingV2ObjectconfigurationMetricDefinitionDTO() + if include_optional: + return ServicingV2ObjectconfigurationMetricDefinitionDTO( + uuid = '', + object_name = '', + basic_information = visier_platform_sdk.models.servicing/v2/objectconfiguration/basic_information_dto.servicing.v2.objectconfiguration.BasicInformationDTO( + display_name = '', + short_display_name = '', + description = '', + explanation = '', + designer_notes = '', + synonym_list = None, ), + details = visier_platform_sdk.models.servicing/v2/objectconfiguration/metric_type_details_dto.servicing.v2.objectconfiguration.MetricTypeDetailsDTO( + process_concept = None, ), + additive_type = 'fullyAdditive' + ) + else: + return ServicingV2ObjectconfigurationMetricDefinitionDTO( + ) + """ + + def testServicingV2ObjectconfigurationMetricDefinitionDTO(self): + """Test ServicingV2ObjectconfigurationMetricDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_metric_type_details_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_metric_type_details_dto.py new file mode 100644 index 0000000000..8f26333435 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_metric_type_details_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_metric_type_details_dto import ServicingV2ObjectconfigurationMetricTypeDetailsDTO + +class TestServicingV2ObjectconfigurationMetricTypeDetailsDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationMetricTypeDetailsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationMetricTypeDetailsDTO: + """Test ServicingV2ObjectconfigurationMetricTypeDetailsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationMetricTypeDetailsDTO` + """ + model = ServicingV2ObjectconfigurationMetricTypeDetailsDTO() + if include_optional: + return ServicingV2ObjectconfigurationMetricTypeDetailsDTO( + process_concept = visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_metric_definition_dto.servicing.v2.objectconfiguration.ProcessConceptMetricDefinitionDTO( + formula = '', + data_type = '', + visible_in_analytics = True, ) + ) + else: + return ServicingV2ObjectconfigurationMetricTypeDetailsDTO( + ) + """ + + def testServicingV2ObjectconfigurationMetricTypeDetailsDTO(self): + """Test ServicingV2ObjectconfigurationMetricTypeDetailsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_object_id_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_object_id_dto.py new file mode 100644 index 0000000000..629081a464 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_object_id_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_object_id_dto import ServicingV2ObjectconfigurationObjectIdDTO + +class TestServicingV2ObjectconfigurationObjectIdDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationObjectIdDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationObjectIdDTO: + """Test ServicingV2ObjectconfigurationObjectIdDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationObjectIdDTO` + """ + model = ServicingV2ObjectconfigurationObjectIdDTO() + if include_optional: + return ServicingV2ObjectconfigurationObjectIdDTO( + uuid = '', + object_name = '' + ) + else: + return ServicingV2ObjectconfigurationObjectIdDTO( + ) + """ + + def testServicingV2ObjectconfigurationObjectIdDTO(self): + """Test ServicingV2ObjectconfigurationObjectIdDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_definition_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_definition_dto.py new file mode 100644 index 0000000000..dc134861ff --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_definition_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_definition_dto import ServicingV2ObjectconfigurationProcessConceptDefinitionDTO + +class TestServicingV2ObjectconfigurationProcessConceptDefinitionDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptDefinitionDTO: + """Test ServicingV2ObjectconfigurationProcessConceptDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptDefinitionDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptDefinitionDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptDefinitionDTO( + analytic_object_name = '', + status_dimension_object_name = '', + participation_concept_uuid = '', + on_hold_concept_uuid = '', + stage_list = visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_stage_list_dto.servicing.v2.objectconfiguration.ProcessConceptStageListDTO( + stages = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_stage_dto.servicing.v2.objectconfiguration.ProcessConceptStageDTO( + uuid = '', + object_name = '', + basic_information = None, + mapped_member_list = None, ) + ], ), + outcome_list = visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_outcome_list_dto.servicing.v2.objectconfiguration.ProcessConceptOutcomeListDTO( + outcomes = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_outcome_dto.servicing.v2.objectconfiguration.ProcessConceptOutcomeDTO( + uuid = '', + object_name = '', + basic_information = None, + outcome_semantic = 'Success', + mapped_member_list = None, ) + ], ), + metric_list = visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_metric_list_dto.servicing.v2.objectconfiguration.ProcessConceptMetricListDTO( + metrics = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/metric_definition_dto.servicing.v2.objectconfiguration.MetricDefinitionDTO( + uuid = '', + object_name = '', + basic_information = None, + details = None, + additive_type = 'fullyAdditive', ) + ], ), + property_list = visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_property_list_dto.servicing.v2.objectconfiguration.ProcessConceptPropertyListDTO( + properties = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/property_definition_dto.servicing.v2.objectconfiguration.PropertyDefinitionDTO( + uuid = '', + object_name = '', + basic_information = None, + details = None, ) + ], ), + tag_list = visier_platform_sdk.models.servicing/v2/objectconfiguration/tag_reference_list_dto.servicing.v2.objectconfiguration.TagReferenceListDTO( + tags = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/tag_reference_dto.servicing.v2.objectconfiguration.TagReferenceDTO( + object_name = '', ) + ], ), + visible_in_analytics = True, + include_with_vee = True + ) + else: + return ServicingV2ObjectconfigurationProcessConceptDefinitionDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptDefinitionDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_member_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_member_dto.py new file mode 100644 index 0000000000..4b5889f649 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_member_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_member_dto import ServicingV2ObjectconfigurationProcessConceptMemberDTO + +class TestServicingV2ObjectconfigurationProcessConceptMemberDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptMemberDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptMemberDTO: + """Test ServicingV2ObjectconfigurationProcessConceptMemberDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptMemberDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptMemberDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptMemberDTO( + display_name = '', + name_path = [ + '' + ] + ) + else: + return ServicingV2ObjectconfigurationProcessConceptMemberDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptMemberDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptMemberDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_member_list_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_member_list_dto.py new file mode 100644 index 0000000000..c5bbbc191f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_member_list_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_member_list_dto import ServicingV2ObjectconfigurationProcessConceptMemberListDTO + +class TestServicingV2ObjectconfigurationProcessConceptMemberListDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptMemberListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptMemberListDTO: + """Test ServicingV2ObjectconfigurationProcessConceptMemberListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptMemberListDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptMemberListDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptMemberListDTO( + members = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_member_dto.servicing.v2.objectconfiguration.ProcessConceptMemberDTO( + display_name = '', + name_path = [ + '' + ], ) + ] + ) + else: + return ServicingV2ObjectconfigurationProcessConceptMemberListDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptMemberListDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptMemberListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_metric_definition_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_metric_definition_dto.py new file mode 100644 index 0000000000..f4173e741e --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_metric_definition_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_metric_definition_dto import ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO + +class TestServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO: + """Test ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO( + formula = '', + data_type = '', + visible_in_analytics = True + ) + else: + return ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_metric_list_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_metric_list_dto.py new file mode 100644 index 0000000000..bea9d6210f --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_metric_list_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_metric_list_dto import ServicingV2ObjectconfigurationProcessConceptMetricListDTO + +class TestServicingV2ObjectconfigurationProcessConceptMetricListDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptMetricListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptMetricListDTO: + """Test ServicingV2ObjectconfigurationProcessConceptMetricListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptMetricListDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptMetricListDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptMetricListDTO( + metrics = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/metric_definition_dto.servicing.v2.objectconfiguration.MetricDefinitionDTO( + uuid = '', + object_name = '', + basic_information = None, + details = None, + additive_type = 'fullyAdditive', ) + ] + ) + else: + return ServicingV2ObjectconfigurationProcessConceptMetricListDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptMetricListDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptMetricListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_outcome_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_outcome_dto.py new file mode 100644 index 0000000000..533645b87a --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_outcome_dto.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_outcome_dto import ServicingV2ObjectconfigurationProcessConceptOutcomeDTO + +class TestServicingV2ObjectconfigurationProcessConceptOutcomeDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptOutcomeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptOutcomeDTO: + """Test ServicingV2ObjectconfigurationProcessConceptOutcomeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptOutcomeDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptOutcomeDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptOutcomeDTO( + uuid = '', + object_name = '', + basic_information = visier_platform_sdk.models.servicing/v2/objectconfiguration/basic_information_dto.servicing.v2.objectconfiguration.BasicInformationDTO( + display_name = '', + short_display_name = '', + description = '', + explanation = '', + designer_notes = '', + synonym_list = None, ), + outcome_semantic = 'Success', + mapped_member_list = visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_member_list_dto.servicing.v2.objectconfiguration.ProcessConceptMemberListDTO( + members = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_member_dto.servicing.v2.objectconfiguration.ProcessConceptMemberDTO( + display_name = '', + name_path = [ + '' + ], ) + ], ) + ) + else: + return ServicingV2ObjectconfigurationProcessConceptOutcomeDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptOutcomeDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptOutcomeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_outcome_list_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_outcome_list_dto.py new file mode 100644 index 0000000000..5e9a226dc0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_outcome_list_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_outcome_list_dto import ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO + +class TestServicingV2ObjectconfigurationProcessConceptOutcomeListDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO: + """Test ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO( + outcomes = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_outcome_dto.servicing.v2.objectconfiguration.ProcessConceptOutcomeDTO( + uuid = '', + object_name = '', + basic_information = None, + outcome_semantic = 'Success', + mapped_member_list = None, ) + ] + ) + else: + return ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptOutcomeListDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_property_list_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_property_list_dto.py new file mode 100644 index 0000000000..d62d164702 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_property_list_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_property_list_dto import ServicingV2ObjectconfigurationProcessConceptPropertyListDTO + +class TestServicingV2ObjectconfigurationProcessConceptPropertyListDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptPropertyListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptPropertyListDTO: + """Test ServicingV2ObjectconfigurationProcessConceptPropertyListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptPropertyListDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptPropertyListDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptPropertyListDTO( + properties = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/property_definition_dto.servicing.v2.objectconfiguration.PropertyDefinitionDTO( + uuid = '', + object_name = '', + basic_information = None, + details = None, ) + ] + ) + else: + return ServicingV2ObjectconfigurationProcessConceptPropertyListDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptPropertyListDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptPropertyListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_property_type_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_property_type_dto.py new file mode 100644 index 0000000000..c5b5fe75a3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_property_type_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_property_type_dto import ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO + +class TestServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO: + """Test ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO( + data_type = '', + primitive_type = '', + formula = '' + ) + else: + return ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_stage_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_stage_dto.py new file mode 100644 index 0000000000..9c94e6e588 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_stage_dto.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_stage_dto import ServicingV2ObjectconfigurationProcessConceptStageDTO + +class TestServicingV2ObjectconfigurationProcessConceptStageDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptStageDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptStageDTO: + """Test ServicingV2ObjectconfigurationProcessConceptStageDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptStageDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptStageDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptStageDTO( + uuid = '', + object_name = '', + basic_information = visier_platform_sdk.models.servicing/v2/objectconfiguration/basic_information_dto.servicing.v2.objectconfiguration.BasicInformationDTO( + display_name = '', + short_display_name = '', + description = '', + explanation = '', + designer_notes = '', + synonym_list = None, ), + mapped_member_list = visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_member_list_dto.servicing.v2.objectconfiguration.ProcessConceptMemberListDTO( + members = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_member_dto.servicing.v2.objectconfiguration.ProcessConceptMemberDTO( + display_name = '', + name_path = [ + '' + ], ) + ], ) + ) + else: + return ServicingV2ObjectconfigurationProcessConceptStageDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptStageDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptStageDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_stage_list_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_stage_list_dto.py new file mode 100644 index 0000000000..6f99aa6e6d --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_process_concept_stage_list_dto.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_stage_list_dto import ServicingV2ObjectconfigurationProcessConceptStageListDTO + +class TestServicingV2ObjectconfigurationProcessConceptStageListDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationProcessConceptStageListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationProcessConceptStageListDTO: + """Test ServicingV2ObjectconfigurationProcessConceptStageListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationProcessConceptStageListDTO` + """ + model = ServicingV2ObjectconfigurationProcessConceptStageListDTO() + if include_optional: + return ServicingV2ObjectconfigurationProcessConceptStageListDTO( + stages = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_stage_dto.servicing.v2.objectconfiguration.ProcessConceptStageDTO( + uuid = '', + object_name = '', + basic_information = None, + mapped_member_list = None, ) + ] + ) + else: + return ServicingV2ObjectconfigurationProcessConceptStageListDTO( + ) + """ + + def testServicingV2ObjectconfigurationProcessConceptStageListDTO(self): + """Test ServicingV2ObjectconfigurationProcessConceptStageListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_property_definition_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_property_definition_dto.py new file mode 100644 index 0000000000..ad40376da0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_property_definition_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_property_definition_dto import ServicingV2ObjectconfigurationPropertyDefinitionDTO + +class TestServicingV2ObjectconfigurationPropertyDefinitionDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationPropertyDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationPropertyDefinitionDTO: + """Test ServicingV2ObjectconfigurationPropertyDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationPropertyDefinitionDTO` + """ + model = ServicingV2ObjectconfigurationPropertyDefinitionDTO() + if include_optional: + return ServicingV2ObjectconfigurationPropertyDefinitionDTO( + uuid = '', + object_name = '', + basic_information = visier_platform_sdk.models.servicing/v2/objectconfiguration/basic_information_dto.servicing.v2.objectconfiguration.BasicInformationDTO( + display_name = '', + short_display_name = '', + description = '', + explanation = '', + designer_notes = '', + synonym_list = None, ), + details = visier_platform_sdk.models.servicing/v2/objectconfiguration/property_type_details_dto.servicing.v2.objectconfiguration.PropertyTypeDetailsDTO( + simple = None, + calculated = None, + process_concept = None, ) + ) + else: + return ServicingV2ObjectconfigurationPropertyDefinitionDTO( + ) + """ + + def testServicingV2ObjectconfigurationPropertyDefinitionDTO(self): + """Test ServicingV2ObjectconfigurationPropertyDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_property_type_details_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_property_type_details_dto.py new file mode 100644 index 0000000000..fa41820158 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_property_type_details_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_property_type_details_dto import ServicingV2ObjectconfigurationPropertyTypeDetailsDTO + +class TestServicingV2ObjectconfigurationPropertyTypeDetailsDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationPropertyTypeDetailsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationPropertyTypeDetailsDTO: + """Test ServicingV2ObjectconfigurationPropertyTypeDetailsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationPropertyTypeDetailsDTO` + """ + model = ServicingV2ObjectconfigurationPropertyTypeDetailsDTO() + if include_optional: + return ServicingV2ObjectconfigurationPropertyTypeDetailsDTO( + simple = visier_platform_sdk.models.servicing/v2/objectconfiguration/simple_property_type_dto.servicing.v2.objectconfiguration.SimplePropertyTypeDTO( + data_type = '', + primitive_type = '', ), + calculated = visier_platform_sdk.models.servicing/v2/objectconfiguration/calculated_property_type_dto.servicing.v2.objectconfiguration.CalculatedPropertyTypeDTO( + data_type = '', + primitive_type = '', + formula = '', ), + process_concept = visier_platform_sdk.models.servicing/v2/objectconfiguration/process_concept_property_type_dto.servicing.v2.objectconfiguration.ProcessConceptPropertyTypeDTO( + data_type = '', + primitive_type = '', + formula = '', ) + ) + else: + return ServicingV2ObjectconfigurationPropertyTypeDetailsDTO( + ) + """ + + def testServicingV2ObjectconfigurationPropertyTypeDetailsDTO(self): + """Test ServicingV2ObjectconfigurationPropertyTypeDetailsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_simple_property_type_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_simple_property_type_dto.py new file mode 100644 index 0000000000..7e7b6563b3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_simple_property_type_dto.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_simple_property_type_dto import ServicingV2ObjectconfigurationSimplePropertyTypeDTO + +class TestServicingV2ObjectconfigurationSimplePropertyTypeDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationSimplePropertyTypeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationSimplePropertyTypeDTO: + """Test ServicingV2ObjectconfigurationSimplePropertyTypeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationSimplePropertyTypeDTO` + """ + model = ServicingV2ObjectconfigurationSimplePropertyTypeDTO() + if include_optional: + return ServicingV2ObjectconfigurationSimplePropertyTypeDTO( + data_type = '', + primitive_type = '' + ) + else: + return ServicingV2ObjectconfigurationSimplePropertyTypeDTO( + ) + """ + + def testServicingV2ObjectconfigurationSimplePropertyTypeDTO(self): + """Test ServicingV2ObjectconfigurationSimplePropertyTypeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_successful_change_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_successful_change_dto.py new file mode 100644 index 0000000000..e0266e2d6e --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_successful_change_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_successful_change_dto import ServicingV2ObjectconfigurationSuccessfulChangeDTO + +class TestServicingV2ObjectconfigurationSuccessfulChangeDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationSuccessfulChangeDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationSuccessfulChangeDTO: + """Test ServicingV2ObjectconfigurationSuccessfulChangeDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationSuccessfulChangeDTO` + """ + model = ServicingV2ObjectconfigurationSuccessfulChangeDTO() + if include_optional: + return ServicingV2ObjectconfigurationSuccessfulChangeDTO( + execution_context = visier_platform_sdk.models.servicing/v2/objectconfiguration/execution_context_dto.servicing.v2.objectconfiguration.ExecutionContextDTO( + tenant_code = '', + project_id = '', ), + object_name = '', + uuid = '', + display_name = '' + ) + else: + return ServicingV2ObjectconfigurationSuccessfulChangeDTO( + ) + """ + + def testServicingV2ObjectconfigurationSuccessfulChangeDTO(self): + """Test ServicingV2ObjectconfigurationSuccessfulChangeDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_synonym_list_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_synonym_list_dto.py new file mode 100644 index 0000000000..8a05e3488e --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_synonym_list_dto.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_synonym_list_dto import ServicingV2ObjectconfigurationSynonymListDTO + +class TestServicingV2ObjectconfigurationSynonymListDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationSynonymListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationSynonymListDTO: + """Test ServicingV2ObjectconfigurationSynonymListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationSynonymListDTO` + """ + model = ServicingV2ObjectconfigurationSynonymListDTO() + if include_optional: + return ServicingV2ObjectconfigurationSynonymListDTO( + synonyms = [ + '' + ] + ) + else: + return ServicingV2ObjectconfigurationSynonymListDTO( + ) + """ + + def testServicingV2ObjectconfigurationSynonymListDTO(self): + """Test ServicingV2ObjectconfigurationSynonymListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_tag_reference_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_tag_reference_dto.py new file mode 100644 index 0000000000..addb26a800 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_tag_reference_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_tag_reference_dto import ServicingV2ObjectconfigurationTagReferenceDTO + +class TestServicingV2ObjectconfigurationTagReferenceDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationTagReferenceDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationTagReferenceDTO: + """Test ServicingV2ObjectconfigurationTagReferenceDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationTagReferenceDTO` + """ + model = ServicingV2ObjectconfigurationTagReferenceDTO() + if include_optional: + return ServicingV2ObjectconfigurationTagReferenceDTO( + object_name = '' + ) + else: + return ServicingV2ObjectconfigurationTagReferenceDTO( + ) + """ + + def testServicingV2ObjectconfigurationTagReferenceDTO(self): + """Test ServicingV2ObjectconfigurationTagReferenceDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_tag_reference_list_dto.py b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_tag_reference_list_dto.py new file mode 100644 index 0000000000..ecb61978cd --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_v2_objectconfiguration_tag_reference_list_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_v2_objectconfiguration_tag_reference_list_dto import ServicingV2ObjectconfigurationTagReferenceListDTO + +class TestServicingV2ObjectconfigurationTagReferenceListDTO(unittest.TestCase): + """ServicingV2ObjectconfigurationTagReferenceListDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingV2ObjectconfigurationTagReferenceListDTO: + """Test ServicingV2ObjectconfigurationTagReferenceListDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingV2ObjectconfigurationTagReferenceListDTO` + """ + model = ServicingV2ObjectconfigurationTagReferenceListDTO() + if include_optional: + return ServicingV2ObjectconfigurationTagReferenceListDTO( + tags = [ + visier_platform_sdk.models.servicing/v2/objectconfiguration/tag_reference_dto.servicing.v2.objectconfiguration.TagReferenceDTO( + object_name = '', ) + ] + ) + else: + return ServicingV2ObjectconfigurationTagReferenceListDTO( + ) + """ + + def testServicingV2ObjectconfigurationTagReferenceListDTO(self): + """Test ServicingV2ObjectconfigurationTagReferenceListDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_vee_question_change_definition_dto.py b/src/visier_platform_sdk/test/test_servicing_vee_question_change_definition_dto.py new file mode 100644 index 0000000000..25041fe852 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_vee_question_change_definition_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_vee_question_change_definition_dto import ServicingVeeQuestionChangeDefinitionDTO + +class TestServicingVeeQuestionChangeDefinitionDTO(unittest.TestCase): + """ServicingVeeQuestionChangeDefinitionDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingVeeQuestionChangeDefinitionDTO: + """Test ServicingVeeQuestionChangeDefinitionDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingVeeQuestionChangeDefinitionDTO` + """ + model = ServicingVeeQuestionChangeDefinitionDTO() + if include_optional: + return ServicingVeeQuestionChangeDefinitionDTO( + question = '', + question_id = '', + visible_in_vee = True, + category_id = '', + user_group_assignment = visier_platform_sdk.models.servicing/user_group_assignment_dto.servicing.UserGroupAssignmentDTO( + user_group_ids = [ + '' + ], ) + ) + else: + return ServicingVeeQuestionChangeDefinitionDTO( + ) + """ + + def testServicingVeeQuestionChangeDefinitionDTO(self): + """Test ServicingVeeQuestionChangeDefinitionDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_vee_question_change_definitions_by_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_vee_question_change_definitions_by_tenant_dto.py new file mode 100644 index 0000000000..3987bb1c50 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_vee_question_change_definitions_by_tenant_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_vee_question_change_definitions_by_tenant_dto import ServicingVeeQuestionChangeDefinitionsByTenantDTO + +class TestServicingVeeQuestionChangeDefinitionsByTenantDTO(unittest.TestCase): + """ServicingVeeQuestionChangeDefinitionsByTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingVeeQuestionChangeDefinitionsByTenantDTO: + """Test ServicingVeeQuestionChangeDefinitionsByTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingVeeQuestionChangeDefinitionsByTenantDTO` + """ + model = ServicingVeeQuestionChangeDefinitionsByTenantDTO() + if include_optional: + return ServicingVeeQuestionChangeDefinitionsByTenantDTO( + tenant_code = '', + project_id = '', + questions = [ + visier_platform_sdk.models.servicing/vee_question_change_definition_dto.servicing.VeeQuestionChangeDefinitionDTO( + question = '', + question_id = '', + visible_in_vee = True, + category_id = '', + user_group_assignment = None, ) + ] + ) + else: + return ServicingVeeQuestionChangeDefinitionsByTenantDTO( + ) + """ + + def testServicingVeeQuestionChangeDefinitionsByTenantDTO(self): + """Test ServicingVeeQuestionChangeDefinitionsByTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_vee_question_change_failure_dto.py b/src/visier_platform_sdk/test/test_servicing_vee_question_change_failure_dto.py new file mode 100644 index 0000000000..515156d855 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_vee_question_change_failure_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_vee_question_change_failure_dto import ServicingVeeQuestionChangeFailureDTO + +class TestServicingVeeQuestionChangeFailureDTO(unittest.TestCase): + """ServicingVeeQuestionChangeFailureDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingVeeQuestionChangeFailureDTO: + """Test ServicingVeeQuestionChangeFailureDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingVeeQuestionChangeFailureDTO` + """ + model = ServicingVeeQuestionChangeFailureDTO() + if include_optional: + return ServicingVeeQuestionChangeFailureDTO( + question = '', + question_id = '', + category_id = '', + user_group_assignment = visier_platform_sdk.models.servicing/user_group_assignment_dto.servicing.UserGroupAssignmentDTO( + user_group_ids = [ + '' + ], ), + message = '', + rci = '', + tenant_code = '', + project_id = '' + ) + else: + return ServicingVeeQuestionChangeFailureDTO( + ) + """ + + def testServicingVeeQuestionChangeFailureDTO(self): + """Test ServicingVeeQuestionChangeFailureDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_vee_question_change_success_dto.py b/src/visier_platform_sdk/test/test_servicing_vee_question_change_success_dto.py new file mode 100644 index 0000000000..22388b695a --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_vee_question_change_success_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_vee_question_change_success_dto import ServicingVeeQuestionChangeSuccessDTO + +class TestServicingVeeQuestionChangeSuccessDTO(unittest.TestCase): + """ServicingVeeQuestionChangeSuccessDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingVeeQuestionChangeSuccessDTO: + """Test ServicingVeeQuestionChangeSuccessDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingVeeQuestionChangeSuccessDTO` + """ + model = ServicingVeeQuestionChangeSuccessDTO() + if include_optional: + return ServicingVeeQuestionChangeSuccessDTO( + question = '', + question_id = '', + visible_in_vee = True, + category_id = '', + user_group_assignment = visier_platform_sdk.models.servicing/user_group_assignment_dto.servicing.UserGroupAssignmentDTO( + user_group_ids = [ + '' + ], ), + tenant_code = '', + project_id = '' + ) + else: + return ServicingVeeQuestionChangeSuccessDTO( + ) + """ + + def testServicingVeeQuestionChangeSuccessDTO(self): + """Test ServicingVeeQuestionChangeSuccessDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_vee_question_delete_definitions_by_tenant_dto.py b/src/visier_platform_sdk/test/test_servicing_vee_question_delete_definitions_by_tenant_dto.py new file mode 100644 index 0000000000..067cd185e3 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_vee_question_delete_definitions_by_tenant_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_vee_question_delete_definitions_by_tenant_dto import ServicingVeeQuestionDeleteDefinitionsByTenantDTO + +class TestServicingVeeQuestionDeleteDefinitionsByTenantDTO(unittest.TestCase): + """ServicingVeeQuestionDeleteDefinitionsByTenantDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingVeeQuestionDeleteDefinitionsByTenantDTO: + """Test ServicingVeeQuestionDeleteDefinitionsByTenantDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingVeeQuestionDeleteDefinitionsByTenantDTO` + """ + model = ServicingVeeQuestionDeleteDefinitionsByTenantDTO() + if include_optional: + return ServicingVeeQuestionDeleteDefinitionsByTenantDTO( + tenant_code = '', + project_id = '', + question_ids = [ + '' + ] + ) + else: + return ServicingVeeQuestionDeleteDefinitionsByTenantDTO( + ) + """ + + def testServicingVeeQuestionDeleteDefinitionsByTenantDTO(self): + """Test ServicingVeeQuestionDeleteDefinitionsByTenantDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_vee_questions_bulk_change_response_dto.py b/src/visier_platform_sdk/test/test_servicing_vee_questions_bulk_change_response_dto.py new file mode 100644 index 0000000000..539544e4f0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_vee_questions_bulk_change_response_dto.py @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_vee_questions_bulk_change_response_dto import ServicingVeeQuestionsBulkChangeResponseDTO + +class TestServicingVeeQuestionsBulkChangeResponseDTO(unittest.TestCase): + """ServicingVeeQuestionsBulkChangeResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingVeeQuestionsBulkChangeResponseDTO: + """Test ServicingVeeQuestionsBulkChangeResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingVeeQuestionsBulkChangeResponseDTO` + """ + model = ServicingVeeQuestionsBulkChangeResponseDTO() + if include_optional: + return ServicingVeeQuestionsBulkChangeResponseDTO( + successes = [ + visier_platform_sdk.models.servicing/vee_question_change_success_dto.servicing.VeeQuestionChangeSuccessDTO( + question = '', + question_id = '', + visible_in_vee = True, + category_id = '', + user_group_assignment = None, + tenant_code = '', + project_id = '', ) + ], + failures = [ + visier_platform_sdk.models.servicing/vee_question_change_failure_dto.servicing.VeeQuestionChangeFailureDTO( + question = '', + question_id = '', + category_id = '', + user_group_assignment = None, + message = '', + rci = '', + tenant_code = '', + project_id = '', ) + ] + ) + else: + return ServicingVeeQuestionsBulkChangeResponseDTO( + ) + """ + + def testServicingVeeQuestionsBulkChangeResponseDTO(self): + """Test ServicingVeeQuestionsBulkChangeResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_vee_questions_change_definitions_dto.py b/src/visier_platform_sdk/test/test_servicing_vee_questions_change_definitions_dto.py new file mode 100644 index 0000000000..c7eaec98a5 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_vee_questions_change_definitions_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_vee_questions_change_definitions_dto import ServicingVeeQuestionsChangeDefinitionsDTO + +class TestServicingVeeQuestionsChangeDefinitionsDTO(unittest.TestCase): + """ServicingVeeQuestionsChangeDefinitionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingVeeQuestionsChangeDefinitionsDTO: + """Test ServicingVeeQuestionsChangeDefinitionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingVeeQuestionsChangeDefinitionsDTO` + """ + model = ServicingVeeQuestionsChangeDefinitionsDTO() + if include_optional: + return ServicingVeeQuestionsChangeDefinitionsDTO( + questions_by_tenant = [ + visier_platform_sdk.models.servicing/vee_question_change_definitions_by_tenant_dto.servicing.VeeQuestionChangeDefinitionsByTenantDTO( + tenant_code = '', + project_id = '', + questions = [ + visier_platform_sdk.models.servicing/vee_question_change_definition_dto.servicing.VeeQuestionChangeDefinitionDTO( + question = '', + question_id = '', + visible_in_vee = True, + category_id = '', + user_group_assignment = None, ) + ], ) + ] + ) + else: + return ServicingVeeQuestionsChangeDefinitionsDTO( + ) + """ + + def testServicingVeeQuestionsChangeDefinitionsDTO(self): + """Test ServicingVeeQuestionsChangeDefinitionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_servicing_vee_questions_delete_definitions_dto.py b/src/visier_platform_sdk/test/test_servicing_vee_questions_delete_definitions_dto.py new file mode 100644 index 0000000000..041ca539a1 --- /dev/null +++ b/src/visier_platform_sdk/test/test_servicing_vee_questions_delete_definitions_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.servicing_vee_questions_delete_definitions_dto import ServicingVeeQuestionsDeleteDefinitionsDTO + +class TestServicingVeeQuestionsDeleteDefinitionsDTO(unittest.TestCase): + """ServicingVeeQuestionsDeleteDefinitionsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServicingVeeQuestionsDeleteDefinitionsDTO: + """Test ServicingVeeQuestionsDeleteDefinitionsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ServicingVeeQuestionsDeleteDefinitionsDTO` + """ + model = ServicingVeeQuestionsDeleteDefinitionsDTO() + if include_optional: + return ServicingVeeQuestionsDeleteDefinitionsDTO( + questions_by_tenant = [ + visier_platform_sdk.models.servicing/vee_question_delete_definitions_by_tenant_dto.servicing.VeeQuestionDeleteDefinitionsByTenantDTO( + tenant_code = '', + project_id = '', + question_ids = [ + '' + ], ) + ] + ) + else: + return ServicingVeeQuestionsDeleteDefinitionsDTO( + ) + """ + + def testServicingVeeQuestionsDeleteDefinitionsDTO(self): + """Test ServicingVeeQuestionsDeleteDefinitionsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_skill.py b/src/visier_platform_sdk/test/test_skill.py new file mode 100644 index 0000000000..c68bc06fef --- /dev/null +++ b/src/visier_platform_sdk/test/test_skill.py @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.skill import Skill + +class TestSkill(unittest.TestCase): + """Skill unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Skill: + """Test Skill + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Skill` + """ + model = Skill() + if include_optional: + return Skill( + id = '', + name = '', + description = '', + skill_group_id = '', + skill_category_id = '', + is_knowledge = True, + skill_type = '', + alternative_titles = [ + '' + ], + remote_index = 1.337, + automation_index = 56 + ) + else: + return Skill( + id = '', + name = '', + description = '', + skill_group_id = '', + skill_category_id = '', + is_knowledge = True, + skill_type = '', + alternative_titles = [ + '' + ], + ) + """ + + def testSkill(self): + """Test Skill""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_skill_category.py b/src/visier_platform_sdk/test/test_skill_category.py new file mode 100644 index 0000000000..966f9df983 --- /dev/null +++ b/src/visier_platform_sdk/test/test_skill_category.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.skill_category import SkillCategory + +class TestSkillCategory(unittest.TestCase): + """SkillCategory unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SkillCategory: + """Test SkillCategory + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SkillCategory` + """ + model = SkillCategory() + if include_optional: + return SkillCategory( + id = '', + name = '', + description = '', + skill_groups = [ + visier_platform_sdk.models.skill_group.SkillGroup( + id = '', + name = '', + description = '', + skill_category_id = '', + skills = [ + visier_platform_sdk.models.skill.Skill( + id = '', + name = '', + description = '', + skill_group_id = '', + skill_category_id = '', + is_knowledge = True, + skill_type = '', + alternative_titles = [ + '' + ], + remote_index = 1.337, + automation_index = 56, ) + ], ) + ] + ) + else: + return SkillCategory( + id = '', + name = '', + description = '', + skill_groups = [ + visier_platform_sdk.models.skill_group.SkillGroup( + id = '', + name = '', + description = '', + skill_category_id = '', + skills = [ + visier_platform_sdk.models.skill.Skill( + id = '', + name = '', + description = '', + skill_group_id = '', + skill_category_id = '', + is_knowledge = True, + skill_type = '', + alternative_titles = [ + '' + ], + remote_index = 1.337, + automation_index = 56, ) + ], ) + ], + ) + """ + + def testSkillCategory(self): + """Test SkillCategory""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_skill_category_entry.py b/src/visier_platform_sdk/test/test_skill_category_entry.py new file mode 100644 index 0000000000..1b21903a55 --- /dev/null +++ b/src/visier_platform_sdk/test/test_skill_category_entry.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.skill_category_entry import SkillCategoryEntry + +class TestSkillCategoryEntry(unittest.TestCase): + """SkillCategoryEntry unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SkillCategoryEntry: + """Test SkillCategoryEntry + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SkillCategoryEntry` + """ + model = SkillCategoryEntry() + if include_optional: + return SkillCategoryEntry( + id = '', + name = '', + description = '' + ) + else: + return SkillCategoryEntry( + id = '', + name = '', + description = '', + ) + """ + + def testSkillCategoryEntry(self): + """Test SkillCategoryEntry""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_skill_entry.py b/src/visier_platform_sdk/test/test_skill_entry.py new file mode 100644 index 0000000000..abb8723c80 --- /dev/null +++ b/src/visier_platform_sdk/test/test_skill_entry.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.skill_entry import SkillEntry + +class TestSkillEntry(unittest.TestCase): + """SkillEntry unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SkillEntry: + """Test SkillEntry + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SkillEntry` + """ + model = SkillEntry() + if include_optional: + return SkillEntry( + id = '', + name = '', + description = '' + ) + else: + return SkillEntry( + id = '', + name = '', + description = '', + ) + """ + + def testSkillEntry(self): + """Test SkillEntry""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_skill_extraction_input.py b/src/visier_platform_sdk/test/test_skill_extraction_input.py new file mode 100644 index 0000000000..9f6c548739 --- /dev/null +++ b/src/visier_platform_sdk/test/test_skill_extraction_input.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.skill_extraction_input import SkillExtractionInput + +class TestSkillExtractionInput(unittest.TestCase): + """SkillExtractionInput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SkillExtractionInput: + """Test SkillExtractionInput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SkillExtractionInput` + """ + model = SkillExtractionInput() + if include_optional: + return SkillExtractionInput( + content = '0123', + language_code = '', + limit = 1 + ) + else: + return SkillExtractionInput( + content = '0123', + ) + """ + + def testSkillExtractionInput(self): + """Test SkillExtractionInput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_skill_group.py b/src/visier_platform_sdk/test/test_skill_group.py new file mode 100644 index 0000000000..c18a90196c --- /dev/null +++ b/src/visier_platform_sdk/test/test_skill_group.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.skill_group import SkillGroup + +class TestSkillGroup(unittest.TestCase): + """SkillGroup unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SkillGroup: + """Test SkillGroup + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SkillGroup` + """ + model = SkillGroup() + if include_optional: + return SkillGroup( + id = '', + name = '', + description = '', + skill_category_id = '', + skills = [ + visier_platform_sdk.models.skill.Skill( + id = '', + name = '', + description = '', + skill_group_id = '', + skill_category_id = '', + is_knowledge = True, + skill_type = '', + alternative_titles = [ + '' + ], + remote_index = 1.337, + automation_index = 56, ) + ] + ) + else: + return SkillGroup( + id = '', + name = '', + description = '', + skill_category_id = '', + skills = [ + visier_platform_sdk.models.skill.Skill( + id = '', + name = '', + description = '', + skill_group_id = '', + skill_category_id = '', + is_knowledge = True, + skill_type = '', + alternative_titles = [ + '' + ], + remote_index = 1.337, + automation_index = 56, ) + ], + ) + """ + + def testSkillGroup(self): + """Test SkillGroup""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_skill_group_entry.py b/src/visier_platform_sdk/test/test_skill_group_entry.py new file mode 100644 index 0000000000..6f5e9b0ec0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_skill_group_entry.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.skill_group_entry import SkillGroupEntry + +class TestSkillGroupEntry(unittest.TestCase): + """SkillGroupEntry unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SkillGroupEntry: + """Test SkillGroupEntry + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SkillGroupEntry` + """ + model = SkillGroupEntry() + if include_optional: + return SkillGroupEntry( + id = '', + name = '', + description = '' + ) + else: + return SkillGroupEntry( + id = '', + name = '', + description = '', + ) + """ + + def testSkillGroupEntry(self): + """Test SkillGroupEntry""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_skill_match_input.py b/src/visier_platform_sdk/test/test_skill_match_input.py new file mode 100644 index 0000000000..de83fec099 --- /dev/null +++ b/src/visier_platform_sdk/test/test_skill_match_input.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.skill_match_input import SkillMatchInput + +class TestSkillMatchInput(unittest.TestCase): + """SkillMatchInput unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SkillMatchInput: + """Test SkillMatchInput + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SkillMatchInput` + """ + model = SkillMatchInput() + if include_optional: + return SkillMatchInput( + skill_set = [["21795",85],["19391",50],["21577",40]], + target_skill_sets = [[["21795",75],["19391",70],["21577",40]],[["15812",90],["16835",88],["30645",76]],[["21577",90],["19391",67],["19237",66]]] + ) + else: + return SkillMatchInput( + ) + """ + + def testSkillMatchInput(self): + """Test SkillMatchInput""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_skills_library_api.py b/src/visier_platform_sdk/test/test_skills_library_api.py new file mode 100644 index 0000000000..e0a3323546 --- /dev/null +++ b/src/visier_platform_sdk/test/test_skills_library_api.py @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.skills_library_api import SkillsLibraryApi + + +class TestSkillsLibraryApi(unittest.TestCase): + """SkillsLibraryApi unit test stubs""" + + def setUp(self) -> None: + self.api = SkillsLibraryApi() + + def tearDown(self) -> None: + pass + + def test_extract_skills(self) -> None: + """Test case for extract_skills + + Extract skills from text + """ + pass + + def test_get_skill(self) -> None: + """Test case for get_skill + + Get skill details by ID + """ + pass + + def test_get_skill_category(self) -> None: + """Test case for get_skill_category + + Get skill category details by ID + """ + pass + + def test_get_skill_group(self) -> None: + """Test case for get_skill_group + + Get skill group details by ID + """ + pass + + def test_list_skill_categories(self) -> None: + """Test case for list_skill_categories + + Retrieve a list of skill categories + """ + pass + + def test_list_skill_groups(self) -> None: + """Test case for list_skill_groups + + Retrieve a list of skill groups + """ + pass + + def test_list_skills(self) -> None: + """Test case for list_skills + + Retrieve a list of skills + """ + pass + + def test_match_skills(self) -> None: + """Test case for match_skills + + Match a skill set to a group of skill sets (targets) + """ + pass + + def test_search_skill(self) -> None: + """Test case for search_skill + + Search skills + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_source_files_download_api.py b/src/visier_platform_sdk/test/test_source_files_download_api.py new file mode 100644 index 0000000000..119f878a36 --- /dev/null +++ b/src/visier_platform_sdk/test/test_source_files_download_api.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.source_files_download_api import SourceFilesDownloadApi + + +class TestSourceFilesDownloadApi(unittest.TestCase): + """SourceFilesDownloadApi unit test stubs""" + + def setUp(self) -> None: + self.api = SourceFilesDownloadApi() + + def tearDown(self) -> None: + pass + + def test_download_source_files(self) -> None: + """Test case for download_source_files + + Download source files + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_source_import_result_summary_dto.py b/src/visier_platform_sdk/test/test_source_import_result_summary_dto.py new file mode 100644 index 0000000000..69370118ec --- /dev/null +++ b/src/visier_platform_sdk/test/test_source_import_result_summary_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.source_import_result_summary_dto import SourceImportResultSummaryDTO + +class TestSourceImportResultSummaryDTO(unittest.TestCase): + """SourceImportResultSummaryDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SourceImportResultSummaryDTO: + """Test SourceImportResultSummaryDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SourceImportResultSummaryDTO` + """ + model = SourceImportResultSummaryDTO() + if include_optional: + return SourceImportResultSummaryDTO( + created = 56, + updated = 56, + ignored = 56, + deleted = 56 + ) + else: + return SourceImportResultSummaryDTO( + ) + """ + + def testSourceImportResultSummaryDTO(self): + """Test SourceImportResultSummaryDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_sources_api.py b/src/visier_platform_sdk/test/test_sources_api.py new file mode 100644 index 0000000000..fdeb930bf8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_sources_api.py @@ -0,0 +1,46 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.sources_api import SourcesApi + + +class TestSourcesApi(unittest.TestCase): + """SourcesApi unit test stubs""" + + def setUp(self) -> None: + self.api = SourcesApi() + + def tearDown(self) -> None: + pass + + def test_put_sources(self) -> None: + """Test case for put_sources + + Import a list of sources + """ + pass + + def test_run_sources_operation(self) -> None: + """Test case for run_sources_operation + + Perform an operation on all sources + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_sources_api_put_response_dto.py b/src/visier_platform_sdk/test/test_sources_api_put_response_dto.py new file mode 100644 index 0000000000..9570e480e0 --- /dev/null +++ b/src/visier_platform_sdk/test/test_sources_api_put_response_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.sources_api_put_response_dto import SourcesAPIPutResponseDTO + +class TestSourcesAPIPutResponseDTO(unittest.TestCase): + """SourcesAPIPutResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SourcesAPIPutResponseDTO: + """Test SourcesAPIPutResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SourcesAPIPutResponseDTO` + """ + model = SourcesAPIPutResponseDTO() + if include_optional: + return SourcesAPIPutResponseDTO( + summary = visier_platform_sdk.models.source_import_result_summary_dto.SourceImportResultSummaryDTO( + created = 56, + updated = 56, + ignored = 56, + deleted = 56, ) + ) + else: + return SourcesAPIPutResponseDTO( + ) + """ + + def testSourcesAPIPutResponseDTO(self): + """Test SourcesAPIPutResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_status.py b/src/visier_platform_sdk/test/test_status.py new file mode 100644 index 0000000000..984175352a --- /dev/null +++ b/src/visier_platform_sdk/test/test_status.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.status import Status + +class TestStatus(unittest.TestCase): + """Status unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> Status: + """Test Status + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `Status` + """ + model = Status() + if include_optional: + return Status( + localized_message = '', + code = '', + message = '', + rci = '', + user_error = True + ) + else: + return Status( + ) + """ + + def testStatus(self): + """Test Status""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_system_status_api.py b/src/visier_platform_sdk/test/test_system_status_api.py new file mode 100644 index 0000000000..42f595feb8 --- /dev/null +++ b/src/visier_platform_sdk/test/test_system_status_api.py @@ -0,0 +1,46 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.system_status_api import SystemStatusApi + + +class TestSystemStatusApi(unittest.TestCase): + """SystemStatusApi unit test stubs""" + + def setUp(self) -> None: + self.api = SystemStatusApi() + + def tearDown(self) -> None: + pass + + def test_post_system_status(self) -> None: + """Test case for post_system_status + + Check the overall current status of Visier's systems + """ + pass + + def test_system_status(self) -> None: + """Test case for system_status + + Check the overall current status of Visier's systems + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_systemstatus_system_status_dto.py b/src/visier_platform_sdk/test/test_systemstatus_system_status_dto.py new file mode 100644 index 0000000000..6074048bbb --- /dev/null +++ b/src/visier_platform_sdk/test/test_systemstatus_system_status_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.systemstatus_system_status_dto import SystemstatusSystemStatusDTO + +class TestSystemstatusSystemStatusDTO(unittest.TestCase): + """SystemstatusSystemStatusDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SystemstatusSystemStatusDTO: + """Test SystemstatusSystemStatusDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SystemstatusSystemStatusDTO` + """ + model = SystemstatusSystemStatusDTO() + if include_optional: + return SystemstatusSystemStatusDTO( + overall = '' + ) + else: + return SystemstatusSystemStatusDTO( + ) + """ + + def testSystemstatusSystemStatusDTO(self): + """Test SystemstatusSystemStatusDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_systemstatus_vee_status_dto.py b/src/visier_platform_sdk/test/test_systemstatus_vee_status_dto.py new file mode 100644 index 0000000000..bfe81c6afd --- /dev/null +++ b/src/visier_platform_sdk/test/test_systemstatus_vee_status_dto.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.systemstatus_vee_status_dto import SystemstatusVeeStatusDTO + +class TestSystemstatusVeeStatusDTO(unittest.TestCase): + """SystemstatusVeeStatusDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SystemstatusVeeStatusDTO: + """Test SystemstatusVeeStatusDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SystemstatusVeeStatusDTO` + """ + model = SystemstatusVeeStatusDTO() + if include_optional: + return SystemstatusVeeStatusDTO( + overall = '' + ) + else: + return SystemstatusVeeStatusDTO( + ) + """ + + def testSystemstatusVeeStatusDTO(self): + """Test SystemstatusVeeStatusDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_table_response_dto.py b/src/visier_platform_sdk/test/test_table_response_dto.py new file mode 100644 index 0000000000..41c1613f8e --- /dev/null +++ b/src/visier_platform_sdk/test/test_table_response_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.table_response_dto import TableResponseDTO + +class TestTableResponseDTO(unittest.TestCase): + """TableResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> TableResponseDTO: + """Test TableResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `TableResponseDTO` + """ + model = TableResponseDTO() + if include_optional: + return TableResponseDTO( + header = { + 'key' : '' + }, + rows = [ + { + 'key' : '' + } + ] + ) + else: + return TableResponseDTO( + ) + """ + + def testTableResponseDTO(self): + """Test TableResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_tenants_v1_api.py b/src/visier_platform_sdk/test/test_tenants_v1_api.py new file mode 100644 index 0000000000..08ef5564b9 --- /dev/null +++ b/src/visier_platform_sdk/test/test_tenants_v1_api.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.tenants_v1_api import TenantsV1Api + + +class TestTenantsV1Api(unittest.TestCase): + """TenantsV1Api unit test stubs""" + + def setUp(self) -> None: + self.api = TenantsV1Api() + + def tearDown(self) -> None: + pass + + def test_add_tenant(self) -> None: + """Test case for add_tenant + + Add an analytic tenant + """ + pass + + def test_add_tenants(self) -> None: + """Test case for add_tenants + + Add analytic tenants + """ + pass + + def test_delete_tenant(self) -> None: + """Test case for delete_tenant + + Deprovision an analytic tenant + """ + pass + + def test_disable_tenant(self) -> None: + """Test case for disable_tenant + + Disable an analytic tenant + """ + pass + + def test_enable_tenant(self) -> None: + """Test case for enable_tenant + + Enable an analytic tenant + """ + pass + + def test_get_tenant(self) -> None: + """Test case for get_tenant + + Retrieve an analytic tenant's details + """ + pass + + def test_get_tenants(self) -> None: + """Test case for get_tenants + + Retrieve a list of all analytic tenants + """ + pass + + def test_update_tenant(self) -> None: + """Test case for update_tenant + + Update an analytic tenant + """ + pass + + def test_validate_tenant(self) -> None: + """Test case for validate_tenant + + Validate an analytic tenant's metric values + """ + pass + + def test_validate_tenants(self) -> None: + """Test case for validate_tenants + + Validate metric values for all analytic tenants + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_tenants_v2_api.py b/src/visier_platform_sdk/test/test_tenants_v2_api.py new file mode 100644 index 0000000000..3fae97cd59 --- /dev/null +++ b/src/visier_platform_sdk/test/test_tenants_v2_api.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.tenants_v2_api import TenantsV2Api + + +class TestTenantsV2Api(unittest.TestCase): + """TenantsV2Api unit test stubs""" + + def setUp(self) -> None: + self.api = TenantsV2Api() + + def tearDown(self) -> None: + pass + + def test_create_tenant(self) -> None: + """Test case for create_tenant + + Add an analytic tenant + """ + pass + + def test_delete_tenant(self) -> None: + """Test case for delete_tenant + + Deprovision an analytic tenant + """ + pass + + def test_list_tenants(self) -> None: + """Test case for list_tenants + + Retrieve a list of all analytic tenants + """ + pass + + def test_tenant_info(self) -> None: + """Test case for tenant_info + + Retrieve an analytic tenant's details + """ + pass + + def test_update_tenant(self) -> None: + """Test case for update_tenant + + Update an analytic tenant + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_token_response.py b/src/visier_platform_sdk/test/test_token_response.py new file mode 100644 index 0000000000..7ca51d5930 --- /dev/null +++ b/src/visier_platform_sdk/test/test_token_response.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.token_response import TokenResponse + +class TestTokenResponse(unittest.TestCase): + """TokenResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> TokenResponse: + """Test TokenResponse + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `TokenResponse` + """ + model = TokenResponse() + if include_optional: + return TokenResponse( + access_token = '', + refresh_token = '', + id_token = '', + token_type = '', + expires_in = 56 + ) + else: + return TokenResponse( + ) + """ + + def testTokenResponse(self): + """Test TokenResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_user_creation_api_response_dto.py b/src/visier_platform_sdk/test/test_user_creation_api_response_dto.py new file mode 100644 index 0000000000..abded3bd3a --- /dev/null +++ b/src/visier_platform_sdk/test/test_user_creation_api_response_dto.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.models.user_creation_api_response_dto import UserCreationAPIResponseDTO + +class TestUserCreationAPIResponseDTO(unittest.TestCase): + """UserCreationAPIResponseDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> UserCreationAPIResponseDTO: + """Test UserCreationAPIResponseDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `UserCreationAPIResponseDTO` + """ + model = UserCreationAPIResponseDTO() + if include_optional: + return UserCreationAPIResponseDTO( + user_id = '', + username = '', + display_name = '', + employee_id = '', + account_enabled = '', + email = '' + ) + else: + return UserCreationAPIResponseDTO( + ) + """ + + def testUserCreationAPIResponseDTO(self): + """Test UserCreationAPIResponseDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_user_groups_v2_api.py b/src/visier_platform_sdk/test/test_user_groups_v2_api.py new file mode 100644 index 0000000000..d750638057 --- /dev/null +++ b/src/visier_platform_sdk/test/test_user_groups_v2_api.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.user_groups_v2_api import UserGroupsV2Api + + +class TestUserGroupsV2Api(unittest.TestCase): + """UserGroupsV2Api unit test stubs""" + + def setUp(self) -> None: + self.api = UserGroupsV2Api() + + def tearDown(self) -> None: + pass + + def test_create_user_groups(self) -> None: + """Test case for create_user_groups + + Create multiple user groups + """ + pass + + def test_delete_user_group(self) -> None: + """Test case for delete_user_group + + Delete a user group + """ + pass + + def test_delete_user_groups(self) -> None: + """Test case for delete_user_groups + + Delete multiple user groups + """ + pass + + def test_get_user_group(self) -> None: + """Test case for get_user_group + + Retrieve the details of a user group + """ + pass + + def test_get_user_groups(self) -> None: + """Test case for get_user_groups + + Retrieve a list of user groups + """ + pass + + def test_patch_user_groups(self) -> None: + """Test case for patch_user_groups + + Patch multiple user groups + """ + pass + + def test_put_user_groups(self) -> None: + """Test case for put_user_groups + + Update multiple user groups + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_users_v1_api.py b/src/visier_platform_sdk/test/test_users_v1_api.py new file mode 100644 index 0000000000..877ba8d30d --- /dev/null +++ b/src/visier_platform_sdk/test/test_users_v1_api.py @@ -0,0 +1,165 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.users_v1_api import UsersV1Api + + +class TestUsersV1Api(unittest.TestCase): + """UsersV1Api unit test stubs""" + + def setUp(self) -> None: + self.api = UsersV1Api() + + def tearDown(self) -> None: + pass + + def test_add_user(self) -> None: + """Test case for add_user + + Add a user + """ + pass + + def test_add_users_to_user_group(self) -> None: + """Test case for add_users_to_user_group + + Assign users to user groups + """ + pass + + def test_assign_permissions(self) -> None: + """Test case for assign_permissions + + Assign permissions to users + """ + pass + + def test_assign_permissions_to_user_groups(self) -> None: + """Test case for assign_permissions_to_user_groups + + Assign permissions to user groups + """ + pass + + def test_delete_user(self) -> None: + """Test case for delete_user + + Delete a user + """ + pass + + def test_get_all_permissions_xlsx(self) -> None: + """Test case for get_all_permissions_xlsx + + Retrieve a list of all permissions in XLSX format + """ + pass + + def test_get_all_user_groups(self) -> None: + """Test case for get_all_user_groups + + Retrieve a list of all user groups + """ + pass + + def test_get_all_users(self) -> None: + """Test case for get_all_users + + Retrieve a list of all users + """ + pass + + def test_get_application_logs_xlsx(self) -> None: + """Test case for get_application_logs_xlsx + + Retrieve the Application Logs + """ + pass + + def test_get_data_security_report_xlsx(self) -> None: + """Test case for get_data_security_report_xlsx + + Retrieve the Data Security Report + """ + pass + + def test_get_permission_assigned_users(self) -> None: + """Test case for get_permission_assigned_users + + Retrieve users that are assigned a specific permission + """ + pass + + def test_get_profile_assignments_xlsx(self) -> None: + """Test case for get_profile_assignments_xlsx + + Retrieve user profile assignments in XLSX format + """ + pass + + def test_get_user_detail(self) -> None: + """Test case for get_user_detail + + Retrieve a user's details + """ + pass + + def test_get_user_group_users(self) -> None: + """Test case for get_user_group_users + + Retrieve a list of user group users + """ + pass + + def test_get_user_permissions_xlsx(self) -> None: + """Test case for get_user_permissions_xlsx + + Retrieve user permissions in XLSX format + """ + pass + + def test_remove_permissions(self) -> None: + """Test case for remove_permissions + + Remove permissions from users + """ + pass + + def test_remove_users_from_user_group(self) -> None: + """Test case for remove_users_from_user_group + + Remove users from user groups + """ + pass + + def test_revoke_permissions_from_user_groups(self) -> None: + """Test case for revoke_permissions_from_user_groups + + Remove permissions from user groups + """ + pass + + def test_update_user(self) -> None: + """Test case for update_user + + Update a user + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_users_v2_api.py b/src/visier_platform_sdk/test/test_users_v2_api.py new file mode 100644 index 0000000000..a8ad421423 --- /dev/null +++ b/src/visier_platform_sdk/test/test_users_v2_api.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.users_v2_api import UsersV2Api + + +class TestUsersV2Api(unittest.TestCase): + """UsersV2Api unit test stubs""" + + def setUp(self) -> None: + self.api = UsersV2Api() + + def tearDown(self) -> None: + pass + + def test_add_users(self) -> None: + """Test case for add_users + + Add users + """ + pass + + def test_delete_users(self) -> None: + """Test case for delete_users + + Delete users + """ + pass + + def test_update_users(self) -> None: + """Test case for update_users + + Update users + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_vee_api.py b/src/visier_platform_sdk/test/test_vee_api.py new file mode 100644 index 0000000000..3a5b7526f6 --- /dev/null +++ b/src/visier_platform_sdk/test/test_vee_api.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.vee_api import VeeApi + + +class TestVeeApi(unittest.TestCase): + """VeeApi unit test stubs""" + + def setUp(self) -> None: + self.api = VeeApi() + + def tearDown(self) -> None: + pass + + def test_vee_feedback(self) -> None: + """Test case for vee_feedback + + Submit Vee feedback + """ + pass + + def test_vee_question_request(self) -> None: + """Test case for vee_question_request + + Ask Vee a question + """ + pass + + def test_vee_sample_questions(self) -> None: + """Test case for vee_sample_questions + + Retrieve a list of sample questions to ask Vee + """ + pass + + def test_vee_status(self) -> None: + """Test case for vee_status + + Check the overall current status of Vee + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/test/test_webhooks_api.py b/src/visier_platform_sdk/test/test_webhooks_api.py new file mode 100644 index 0000000000..d4bd4d2838 --- /dev/null +++ b/src/visier_platform_sdk/test/test_webhooks_api.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from visier_platform_sdk.api.webhooks_api import WebhooksApi + + +class TestWebhooksApi(unittest.TestCase): + """WebhooksApi unit test stubs""" + + def setUp(self) -> None: + self.api = WebhooksApi() + + def tearDown(self) -> None: + pass + + def test_create_webhook(self) -> None: + """Test case for create_webhook + + Create a webhook + """ + pass + + def test_delete_webhook(self) -> None: + """Test case for delete_webhook + + Delete a webhook + """ + pass + + def test_delete_webhook_credentials(self) -> None: + """Test case for delete_webhook_credentials + + Delete a webhook's credentials + """ + pass + + def test_get_all_webhooks(self) -> None: + """Test case for get_all_webhooks + + Retrieve a list of webhooks + """ + pass + + def test_get_webhook(self) -> None: + """Test case for get_webhook + + Retrieve a webhook's details + """ + pass + + def test_send_test_event(self) -> None: + """Test case for send_test_event + + Test a webhook + """ + pass + + def test_update_webhook(self) -> None: + """Test case for update_webhook + + Update a webhook's details + """ + pass + + def test_update_webhook_credentials(self) -> None: + """Test case for update_webhook_credentials + + Update a webhook's credentials + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/visier_platform_sdk/tox.ini b/src/visier_platform_sdk/tox.ini new file mode 100644 index 0000000000..de3fca79fb --- /dev/null +++ b/src/visier_platform_sdk/tox.ini @@ -0,0 +1,9 @@ +[tox] +envlist = py3 + +[testenv] +deps=-r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +commands= + pytest --cov=visier_platform_sdk diff --git a/src/visier_platform_sdk/visier_platform_sdk/__init__.py b/src/visier_platform_sdk/visier_platform_sdk/__init__.py new file mode 100644 index 0000000000..a02424ad7f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/__init__.py @@ -0,0 +1,684 @@ +# coding: utf-8 + +# flake8: noqa + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +__version__ = "22222222.99201.1892.beta3" + +# import apis into sdk package +from visier_platform_sdk.api.basic_authentication_api import BasicAuthenticationApi +from visier_platform_sdk.api.benchmarks_api import BenchmarksApi +from visier_platform_sdk.api.concepts_v2_api import ConceptsV2Api +from visier_platform_sdk.api.consolidated_analytics_api import ConsolidatedAnalyticsApi +from visier_platform_sdk.api.data_and_job_handling_api import DataAndJobHandlingApi +from visier_platform_sdk.api.data_intake_api import DataIntakeApi +from visier_platform_sdk.api.data_model_api import DataModelApi +from visier_platform_sdk.api.data_query_api import DataQueryApi +from visier_platform_sdk.api.data_upload_api import DataUploadApi +from visier_platform_sdk.api.data_version_export_api import DataVersionExportApi +from visier_platform_sdk.api.dimensions_api import DimensionsApi +from visier_platform_sdk.api.direct_data_intake_api import DirectDataIntakeApi +from visier_platform_sdk.api.email_domains_api import EmailDomainsApi +from visier_platform_sdk.api.encryption_keys_api import EncryptionKeysApi +from visier_platform_sdk.api.jobs_library_api import JobsLibraryApi +from visier_platform_sdk.api.network_subnets_api import NetworkSubnetsApi +from visier_platform_sdk.api.o_auth2_api import OAuth2Api +from visier_platform_sdk.api.object_configuration_api import ObjectConfigurationApi +from visier_platform_sdk.api.pgp_key_api import PGPKeyApi +from visier_platform_sdk.api.permissions_api import PermissionsApi +from visier_platform_sdk.api.planning_data_load_api import PlanningDataLoadApi +from visier_platform_sdk.api.production_versions_api import ProductionVersionsApi +from visier_platform_sdk.api.profiles_api import ProfilesApi +from visier_platform_sdk.api.projects_api import ProjectsApi +from visier_platform_sdk.api.release_version_configuration_api import ReleaseVersionConfigurationApi +from visier_platform_sdk.api.reporting_api import ReportingApi +from visier_platform_sdk.api.search_api import SearchApi +from visier_platform_sdk.api.skills_library_api import SkillsLibraryApi +from visier_platform_sdk.api.source_files_download_api import SourceFilesDownloadApi +from visier_platform_sdk.api.sources_api import SourcesApi +from visier_platform_sdk.api.system_status_api import SystemStatusApi +from visier_platform_sdk.api.tenants_v1_api import TenantsV1Api +from visier_platform_sdk.api.tenants_v2_api import TenantsV2Api +from visier_platform_sdk.api.user_groups_v2_api import UserGroupsV2Api +from visier_platform_sdk.api.users_v1_api import UsersV1Api +from visier_platform_sdk.api.users_v2_api import UsersV2Api +from visier_platform_sdk.api.vee_api import VeeApi +from visier_platform_sdk.api.webhooks_api import WebhooksApi + +# import ApiClient +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.api_client import ApiClient +from visier_platform_sdk.configuration import Configuration +from visier_platform_sdk.exceptions import OpenApiException +from visier_platform_sdk.exceptions import ApiTypeError +from visier_platform_sdk.exceptions import ApiValueError +from visier_platform_sdk.exceptions import ApiKeyError +from visier_platform_sdk.exceptions import ApiAttributeError +from visier_platform_sdk.exceptions import ApiException + +# import models into sdk package +from visier_platform_sdk.models.admin_all_tenants_status_apidto import AdminAllTenantsStatusAPIDTO +from visier_platform_sdk.models.admin_assign_connector_credentials_by_tenant_response_dto import AdminAssignConnectorCredentialsByTenantResponseDTO +from visier_platform_sdk.models.admin_assign_connector_credentials_response_dto import AdminAssignConnectorCredentialsResponseDTO +from visier_platform_sdk.models.admin_assign_connector_with_credentials_response_dto import AdminAssignConnectorWithCredentialsResponseDTO +from visier_platform_sdk.models.admin_assigned_credential_info_response_dto import AdminAssignedCredentialInfoResponseDTO +from visier_platform_sdk.models.admin_batch_tenant_provision_apidto import AdminBatchTenantProvisionAPIDTO +from visier_platform_sdk.models.admin_business_location_dto import AdminBusinessLocationDTO +from visier_platform_sdk.models.admin_connector_info_response_dto import AdminConnectorInfoResponseDTO +from visier_platform_sdk.models.admin_connector_setting_request_dto import AdminConnectorSettingRequestDTO +from visier_platform_sdk.models.admin_connector_setting_response_dto import AdminConnectorSettingResponseDTO +from visier_platform_sdk.models.admin_connector_settings_response_dto import AdminConnectorSettingsResponseDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_excluded_source_list_dto import AdminConsolidatedAnalyticsAPIExcludedSourceListDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_source_tenant_list_dto import AdminConsolidatedAnalyticsAPISourceTenantListDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_create_request_dto import AdminConsolidatedAnalyticsAPITenantCreateRequestDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_list_response_dto import AdminConsolidatedAnalyticsAPITenantListResponseDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_with_details import AdminConsolidatedAnalyticsAPITenantWithDetails +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_with_details_list_response_dto import AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO +from visier_platform_sdk.models.admin_custom_property_dto import AdminCustomPropertyDTO +from visier_platform_sdk.models.admin_custom_tenant_property_dto import AdminCustomTenantPropertyDTO +from visier_platform_sdk.models.admin_data_import_definition_apidto import AdminDataImportDefinitionAPIDTO +from visier_platform_sdk.models.admin_data_import_definitions_apidto import AdminDataImportDefinitionsAPIDTO +from visier_platform_sdk.models.admin_data_version_and_date_dto import AdminDataVersionAndDateDTO +from visier_platform_sdk.models.admin_delete_user_group_v2_request import AdminDeleteUserGroupV2Request +from visier_platform_sdk.models.admin_element_ids_dto import AdminElementIDsDTO +from visier_platform_sdk.models.admin_email_domains_dto import AdminEmailDomainsDTO +from visier_platform_sdk.models.admin_excluded_sources_body import AdminExcludedSourcesBody +from visier_platform_sdk.models.admin_extractor_setting_apidto import AdminExtractorSettingAPIDTO +from visier_platform_sdk.models.admin_extractor_setting_key_value_apidto import AdminExtractorSettingKeyValueAPIDTO +from visier_platform_sdk.models.admin_extractor_settings_apidto import AdminExtractorSettingsAPIDTO +from visier_platform_sdk.models.admin_home_analysis_by_user_group_dto import AdminHomeAnalysisByUserGroupDTO +from visier_platform_sdk.models.admin_jobs_consolidated_analytics_job_request_dto import AdminJobsConsolidatedAnalyticsJobRequestDTO +from visier_platform_sdk.models.admin_jobs_extract_data_and_load_dto import AdminJobsExtractDataAndLoadDTO +from visier_platform_sdk.models.admin_jobs_processing_job_request_dto import AdminJobsProcessingJobRequestDTO +from visier_platform_sdk.models.admin_key_name import AdminKeyName +from visier_platform_sdk.models.admin_mask_message import AdminMaskMessage +from visier_platform_sdk.models.admin_multiple_tenant_data_versions_details_dto import AdminMultipleTenantDataVersionsDetailsDTO +from visier_platform_sdk.models.admin_multiple_tenant_data_versions_list_dto import AdminMultipleTenantDataVersionsListDTO +from visier_platform_sdk.models.admin_network_subnets_message_request import AdminNetworkSubnetsMessageRequest +from visier_platform_sdk.models.admin_network_subnets_message_response import AdminNetworkSubnetsMessageResponse +from visier_platform_sdk.models.admin_permission_response_dto import AdminPermissionResponseDTO +from visier_platform_sdk.models.admin_permissions_list_dto import AdminPermissionsListDTO +from visier_platform_sdk.models.admin_permissions_to_user_group_for_tenant_dto import AdminPermissionsToUserGroupForTenantDTO +from visier_platform_sdk.models.admin_permissions_to_user_group_request_dto import AdminPermissionsToUserGroupRequestDTO +from visier_platform_sdk.models.admin_permissions_to_user_groups_request_dto import AdminPermissionsToUserGroupsRequestDTO +from visier_platform_sdk.models.admin_product_release_dto import AdminProductReleaseDTO +from visier_platform_sdk.models.admin_product_releases_dto import AdminProductReleasesDTO +from visier_platform_sdk.models.admin_product_version_dto import AdminProductVersionDTO +from visier_platform_sdk.models.admin_product_versions_dto import AdminProductVersionsDTO +from visier_platform_sdk.models.admin_product_versions_update_failure_tenant_response_dto import AdminProductVersionsUpdateFailureTenantResponseDTO +from visier_platform_sdk.models.admin_product_versions_update_response_dto import AdminProductVersionsUpdateResponseDTO +from visier_platform_sdk.models.admin_product_versions_update_successful_tenant_response_dto import AdminProductVersionsUpdateSuccessfulTenantResponseDTO +from visier_platform_sdk.models.admin_put_project_commits_request import AdminPutProjectCommitsRequest +from visier_platform_sdk.models.admin_security_assignment_response_dto import AdminSecurityAssignmentResponseDTO +from visier_platform_sdk.models.admin_set_connector_setting_request_dto import AdminSetConnectorSettingRequestDTO +from visier_platform_sdk.models.admin_set_connector_setting_response_dto import AdminSetConnectorSettingResponseDTO +from visier_platform_sdk.models.admin_set_connector_settings_request_dto import AdminSetConnectorSettingsRequestDTO +from visier_platform_sdk.models.admin_set_connector_settings_response_dto import AdminSetConnectorSettingsResponseDTO +from visier_platform_sdk.models.admin_simple_user_dto import AdminSimpleUserDTO +from visier_platform_sdk.models.admin_target_project_for_tenant_dto import AdminTargetProjectForTenantDTO +from visier_platform_sdk.models.admin_target_project_for_tenants_list_dto import AdminTargetProjectForTenantsListDTO +from visier_platform_sdk.models.admin_tenant_assignments_dto import AdminTenantAssignmentsDTO +from visier_platform_sdk.models.admin_tenant_code_body import AdminTenantCodeBody +from visier_platform_sdk.models.admin_tenant_connector_settings_request_dto import AdminTenantConnectorSettingsRequestDTO +from visier_platform_sdk.models.admin_tenant_detail_apidto import AdminTenantDetailAPIDTO +from visier_platform_sdk.models.admin_tenant_details_traits_dto import AdminTenantDetailsTraitsDTO +from visier_platform_sdk.models.admin_tenant_management_api_get_response_dto import AdminTenantManagementAPIGetResponseDTO +from visier_platform_sdk.models.admin_tenant_management_api_list_response_dto import AdminTenantManagementAPIListResponseDTO +from visier_platform_sdk.models.admin_tenant_management_api_update_request_dto import AdminTenantManagementAPIUpdateRequestDTO +from visier_platform_sdk.models.admin_tenant_management_api_update_response_dto import AdminTenantManagementAPIUpdateResponseDTO +from visier_platform_sdk.models.admin_tenant_provision_apidto import AdminTenantProvisionAPIDTO +from visier_platform_sdk.models.admin_tenant_status_apidto import AdminTenantStatusAPIDTO +from visier_platform_sdk.models.admin_update_tenant_model import AdminUpdateTenantModel +from visier_platform_sdk.models.admin_user_group_change_definition_dto import AdminUserGroupChangeDefinitionDTO +from visier_platform_sdk.models.admin_user_group_change_dimension_filter_dto import AdminUserGroupChangeDimensionFilterDTO +from visier_platform_sdk.models.admin_user_group_change_failure_dto import AdminUserGroupChangeFailureDTO +from visier_platform_sdk.models.admin_user_group_change_filter_dto import AdminUserGroupChangeFilterDTO +from visier_platform_sdk.models.admin_user_group_change_member_selection_dto import AdminUserGroupChangeMemberSelectionDTO +from visier_platform_sdk.models.admin_user_group_change_response_dto import AdminUserGroupChangeResponseDTO +from visier_platform_sdk.models.admin_user_group_change_success_dto import AdminUserGroupChangeSuccessDTO +from visier_platform_sdk.models.admin_user_group_change_users_dto import AdminUserGroupChangeUsersDTO +from visier_platform_sdk.models.admin_user_group_delete_dto import AdminUserGroupDeleteDTO +from visier_platform_sdk.models.admin_user_group_delete_failure_dto import AdminUserGroupDeleteFailureDTO +from visier_platform_sdk.models.admin_user_group_delete_response_dto import AdminUserGroupDeleteResponseDTO +from visier_platform_sdk.models.admin_user_group_delete_success_dto import AdminUserGroupDeleteSuccessDTO +from visier_platform_sdk.models.admin_user_group_filters_dto import AdminUserGroupFiltersDTO +from visier_platform_sdk.models.admin_user_group_get_api_response_dto import AdminUserGroupGetAPIResponseDTO +from visier_platform_sdk.models.admin_user_group_single_delete_response_dto import AdminUserGroupSingleDeleteResponseDTO +from visier_platform_sdk.models.admin_user_groups_change_dto import AdminUserGroupsChangeDTO +from visier_platform_sdk.models.admin_user_groups_delete_request_dto import AdminUserGroupsDeleteRequestDTO +from visier_platform_sdk.models.admin_user_groups_get_api_response_dto import AdminUserGroupsGetAPIResponseDTO +from visier_platform_sdk.models.admin_user_groups_users_dto import AdminUserGroupsUsersDTO +from visier_platform_sdk.models.admin_user_groups_users_for_tenant_dto import AdminUserGroupsUsersForTenantDTO +from visier_platform_sdk.models.admin_user_security_assignments_dto import AdminUserSecurityAssignmentsDTO +from visier_platform_sdk.models.admin_users_to_user_group_request_dto import AdminUsersToUserGroupRequestDTO +from visier_platform_sdk.models.admin_users_to_user_groups_request_dto import AdminUsersToUserGroupsRequestDTO +from visier_platform_sdk.models.analysis_common_report_create_request_dto import AnalysisCommonReportCreateRequestDTO +from visier_platform_sdk.models.analysis_common_report_dto import AnalysisCommonReportDTO +from visier_platform_sdk.models.analysis_common_report_delete_success_dto import AnalysisCommonReportDeleteSuccessDTO +from visier_platform_sdk.models.analysis_common_report_list_response_dto import AnalysisCommonReportListResponseDTO +from visier_platform_sdk.models.analysis_common_vee_clarification_dto import AnalysisCommonVeeClarificationDTO +from visier_platform_sdk.models.analysis_common_vee_conversation_state_dto import AnalysisCommonVeeConversationStateDTO +from visier_platform_sdk.models.analysis_common_vee_corrections_dto import AnalysisCommonVeeCorrectionsDTO +from visier_platform_sdk.models.analysis_common_vee_data_dto import AnalysisCommonVeeDataDTO +from visier_platform_sdk.models.analysis_common_vee_feedback_dto import AnalysisCommonVeeFeedbackDTO +from visier_platform_sdk.models.analysis_common_vee_options_dto import AnalysisCommonVeeOptionsDTO +from visier_platform_sdk.models.analysis_common_vee_question_dto import AnalysisCommonVeeQuestionDTO +from visier_platform_sdk.models.analysis_common_vee_response_dto import AnalysisCommonVeeResponseDTO +from visier_platform_sdk.models.analysis_common_vee_response_schema_dto import AnalysisCommonVeeResponseSchemaDTO +from visier_platform_sdk.models.analysis_common_vee_response_schema_reference_dto import AnalysisCommonVeeResponseSchemaReferenceDTO +from visier_platform_sdk.models.analysis_common_vee_sample_question_dto import AnalysisCommonVeeSampleQuestionDTO +from visier_platform_sdk.models.analysis_common_vee_sample_question_library_dto import AnalysisCommonVeeSampleQuestionLibraryDTO +from visier_platform_sdk.models.analysis_common_vee_status_code_dto import AnalysisCommonVeeStatusCodeDTO +from visier_platform_sdk.models.analysis_common_vee_visual_dto import AnalysisCommonVeeVisualDTO +from visier_platform_sdk.models.analysis_common_vee_visual_options_dto import AnalysisCommonVeeVisualOptionsDTO +from visier_platform_sdk.models.api_error import ApiError +from visier_platform_sdk.models.authentication_o_auth2_user_info_dto import AuthenticationOAuth2UserInfoDTO +from visier_platform_sdk.models.authentication_o_auth2_user_subnet_info_dto import AuthenticationOAuth2UserSubnetInfoDTO +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_detail_dto import AuthenticationOAuth2UserTenantDetailDTO +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_details_dto import AuthenticationOAuth2UserTenantDetailsDTO +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_properties_dto import AuthenticationOAuth2UserTenantPropertiesDTO +from visier_platform_sdk.models.benchmark_info import BenchmarkInfo +from visier_platform_sdk.models.benchmark_value import BenchmarkValue +from visier_platform_sdk.models.data_in_assign_connector_credential_request import DataInAssignConnectorCredentialRequest +from visier_platform_sdk.models.data_in_connector import DataInConnector +from visier_platform_sdk.models.data_in_data_load_request import DataInDataLoadRequest +from visier_platform_sdk.models.data_in_data_load_request_model import DataInDataLoadRequestModel +from visier_platform_sdk.models.data_in_data_load_response import DataInDataLoadResponse +from visier_platform_sdk.models.data_in_data_transfer_result_detail import DataInDataTransferResultDetail +from visier_platform_sdk.models.data_in_data_version_object import DataInDataVersionObject +from visier_platform_sdk.models.data_in_disable_dv_model import DataInDisableDVModel +from visier_platform_sdk.models.data_in_disable_dv_request import DataInDisableDVRequest +from visier_platform_sdk.models.data_in_disable_dv_response import DataInDisableDVResponse +from visier_platform_sdk.models.data_in_dispatching_job_status_response import DataInDispatchingJobStatusResponse +from visier_platform_sdk.models.data_in_exclude_data_uploads_request import DataInExcludeDataUploadsRequest +from visier_platform_sdk.models.data_in_extraction_job import DataInExtractionJob +from visier_platform_sdk.models.data_in_extraction_job_and_status_response import DataInExtractionJobAndStatusResponse +from visier_platform_sdk.models.data_in_include_data_uploads_request import DataInIncludeDataUploadsRequest +from visier_platform_sdk.models.data_in_job_status_list_response import DataInJobStatusListResponse +from visier_platform_sdk.models.data_in_job_status_with_start_time import DataInJobStatusWithStartTime +from visier_platform_sdk.models.data_in_processing_job import DataInProcessingJob +from visier_platform_sdk.models.data_in_processing_job_and_status_response import DataInProcessingJobAndStatusResponse +from visier_platform_sdk.models.data_in_processing_job_status_response import DataInProcessingJobStatusResponse +from visier_platform_sdk.models.data_in_push_data_cancel_response import DataInPushDataCancelResponse +from visier_platform_sdk.models.data_in_push_data_complete_request import DataInPushDataCompleteRequest +from visier_platform_sdk.models.data_in_push_data_complete_response import DataInPushDataCompleteResponse +from visier_platform_sdk.models.data_in_push_data_response import DataInPushDataResponse +from visier_platform_sdk.models.data_in_receiving_job import DataInReceivingJob +from visier_platform_sdk.models.data_in_receiving_job_and_status_response import DataInReceivingJobAndStatusResponse +from visier_platform_sdk.models.data_in_receiving_job_status_response import DataInReceivingJobStatusResponse +from visier_platform_sdk.models.data_in_result import DataInResult +from visier_platform_sdk.models.data_in_source import DataInSource +from visier_platform_sdk.models.data_in_start_extraction_response import DataInStartExtractionResponse +from visier_platform_sdk.models.data_in_start_transfer_response import DataInStartTransferResponse +from visier_platform_sdk.models.data_in_tenant import DataInTenant +from visier_platform_sdk.models.data_in_tenant_and_credential import DataInTenantAndCredential +from visier_platform_sdk.models.data_in_upload_to_exclude import DataInUploadToExclude +from visier_platform_sdk.models.data_in_upload_to_include import DataInUploadToInclude +from visier_platform_sdk.models.data_out_list_response import DataOutListResponse +from visier_platform_sdk.models.dataservices_common_dimension_member_reference_dto import DataservicesCommonDimensionMemberReferenceDTO +from visier_platform_sdk.models.dataservices_common_member_values_dto import DataservicesCommonMemberValuesDTO +from visier_platform_sdk.models.dataservices_datamodel_aggregation_type_option_dto import DataservicesDatamodelAggregationTypeOptionDTO +from visier_platform_sdk.models.dataservices_datamodel_aggregation_type_parameter_dto import DataservicesDatamodelAggregationTypeParameterDTO +from visier_platform_sdk.models.dataservices_datamodel_analytic_object_dto import DataservicesDatamodelAnalyticObjectDTO +from visier_platform_sdk.models.dataservices_datamodel_analytic_objects_dto import DataservicesDatamodelAnalyticObjectsDTO +from visier_platform_sdk.models.dataservices_datamodel_currencies_dto import DataservicesDatamodelCurrenciesDTO +from visier_platform_sdk.models.dataservices_datamodel_currency_dto import DataservicesDatamodelCurrencyDTO +from visier_platform_sdk.models.dataservices_datamodel_currency_rate_dto import DataservicesDatamodelCurrencyRateDTO +from visier_platform_sdk.models.dataservices_datamodel_currency_rates_dto import DataservicesDatamodelCurrencyRatesDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_dto import DataservicesDatamodelDimensionDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_mapping_validation_dto import DataservicesDatamodelDimensionMappingValidationDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_mapping_validation_execution_dto import DataservicesDatamodelDimensionMappingValidationExecutionDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_dimensions_dto import DataservicesDatamodelDimensionsDTO +from visier_platform_sdk.models.dataservices_datamodel_level_dto import DataservicesDatamodelLevelDTO +from visier_platform_sdk.models.dataservices_datamodel_member_dto import DataservicesDatamodelMemberDTO +from visier_platform_sdk.models.dataservices_datamodel_member_parameter_definition_dto import DataservicesDatamodelMemberParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_members_dto import DataservicesDatamodelMembersDTO +from visier_platform_sdk.models.dataservices_datamodel_metric_dto import DataservicesDatamodelMetricDTO +from visier_platform_sdk.models.dataservices_datamodel_metrics_dto import DataservicesDatamodelMetricsDTO +from visier_platform_sdk.models.dataservices_datamodel_numeric_parameter_definition_dto import DataservicesDatamodelNumericParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_object_reference_dto import DataservicesDatamodelObjectReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_parameter_definition_dto import DataservicesDatamodelParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_plan_parameter_definition_dto import DataservicesDatamodelPlanParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_concept_filter_context_dto import DataservicesDatamodelPlanningConceptFilterContextDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_hierarchy_filter_context_dto import DataservicesDatamodelPlanningHierarchyFilterContextDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_model_dto import DataservicesDatamodelPlanningModelDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_models_dto import DataservicesDatamodelPlanningModelsDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_plan_context_dto import DataservicesDatamodelPlanningPlanContextDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_plan_dto import DataservicesDatamodelPlanningPlanDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_plans_dto import DataservicesDatamodelPlanningPlansDTO +from visier_platform_sdk.models.dataservices_datamodel_population_configuration_dto import DataservicesDatamodelPopulationConfigurationDTO +from visier_platform_sdk.models.dataservices_datamodel_prediction_dto import DataservicesDatamodelPredictionDTO +from visier_platform_sdk.models.dataservices_datamodel_predictions_dto import DataservicesDatamodelPredictionsDTO +from visier_platform_sdk.models.dataservices_datamodel_properties_dto import DataservicesDatamodelPropertiesDTO +from visier_platform_sdk.models.dataservices_datamodel_property_dto import DataservicesDatamodelPropertyDTO +from visier_platform_sdk.models.dataservices_datamodel_property_reference_dto import DataservicesDatamodelPropertyReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_scenario_or_snapshot_dto import DataservicesDatamodelScenarioOrSnapshotDTO +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_dto import DataservicesDatamodelSelectionConceptDTO +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_reference_dto import DataservicesDatamodelSelectionConceptReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_selection_concepts_dto import DataservicesDatamodelSelectionConceptsDTO +from visier_platform_sdk.models.dataservices_datamodel_tag_map_element_dto import DataservicesDatamodelTagMapElementDTO +from visier_platform_sdk.models.dataservices_datamodel_validity_range_dto import DataservicesDatamodelValidityRangeDTO +from visier_platform_sdk.models.dataservices_query_aggregation_query_dto import DataservicesQueryAggregationQueryDTO +from visier_platform_sdk.models.dataservices_query_aggregation_query_execution_dto import DataservicesQueryAggregationQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_dto import DataservicesQueryAggregationQuerySourceDTO +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_metric_dto import DataservicesQueryAggregationQuerySourceMetricDTO +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_metrics_dto import DataservicesQueryAggregationQuerySourceMetricsDTO +from visier_platform_sdk.models.dataservices_query_aggregation_type_parameter_value_dto import DataservicesQueryAggregationTypeParameterValueDTO +from visier_platform_sdk.models.dataservices_query_cell_dto import DataservicesQueryCellDTO +from visier_platform_sdk.models.dataservices_query_cell_distribution_bin_dto import DataservicesQueryCellDistributionBinDTO +from visier_platform_sdk.models.dataservices_query_cell_distribution_options_dto import DataservicesQueryCellDistributionOptionsDTO +from visier_platform_sdk.models.dataservices_query_cell_set_axis_dto import DataservicesQueryCellSetAxisDTO +from visier_platform_sdk.models.dataservices_query_cell_set_axis_position_dto import DataservicesQueryCellSetAxisPositionDTO +from visier_platform_sdk.models.dataservices_query_cell_set_dto import DataservicesQueryCellSetDTO +from visier_platform_sdk.models.dataservices_query_cell_set_or_error_dto import DataservicesQueryCellSetOrErrorDTO +from visier_platform_sdk.models.dataservices_query_cohort_filter_dto import DataservicesQueryCohortFilterDTO +from visier_platform_sdk.models.dataservices_query_internal_query_execution_options_dto import DataservicesQueryInternalQueryExecutionOptionsDTO +from visier_platform_sdk.models.dataservices_query_key_group_filter_dto import DataservicesQueryKeyGroupFilterDTO +from visier_platform_sdk.models.dataservices_query_key_group_filter_item_dto import DataservicesQueryKeyGroupFilterItemDTO +from visier_platform_sdk.models.dataservices_query_lineage_dto import DataservicesQueryLineageDTO +from visier_platform_sdk.models.dataservices_query_list_query_execution_dto import DataservicesQueryListQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_list_query_execution_options_dto import DataservicesQueryListQueryExecutionOptionsDTO +from visier_platform_sdk.models.dataservices_query_list_query_source_dto import DataservicesQueryListQuerySourceDTO +from visier_platform_sdk.models.dataservices_query_member_filter_dto import DataservicesQueryMemberFilterDTO +from visier_platform_sdk.models.dataservices_query_member_parameter_value_dto import DataservicesQueryMemberParameterValueDTO +from visier_platform_sdk.models.dataservices_query_numeric_parameter_value_dto import DataservicesQueryNumericParameterValueDTO +from visier_platform_sdk.models.dataservices_query_plan_parameter_value_dto import DataservicesQueryPlanParameterValueDTO +from visier_platform_sdk.models.dataservices_query_property_column_dto import DataservicesQueryPropertyColumnDTO +from visier_platform_sdk.models.dataservices_query_query_axis_dto import DataservicesQueryQueryAxisDTO +from visier_platform_sdk.models.dataservices_query_query_axis_options_dto import DataservicesQueryQueryAxisOptionsDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_data_member_selection_dto import DataservicesQueryQueryDimensionDataMemberSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_leaf_selection_dto import DataservicesQueryQueryDimensionLeafSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_level_property_dto import DataservicesQueryQueryDimensionLevelPropertyDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_level_selection_dto import DataservicesQueryQueryDimensionLevelSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_member_selection_dto import DataservicesQueryQueryDimensionMemberSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_execution_error_dto import DataservicesQueryQueryExecutionErrorDTO +from visier_platform_sdk.models.dataservices_query_query_execution_error_details_dto import DataservicesQueryQueryExecutionErrorDetailsDTO +from visier_platform_sdk.models.dataservices_query_query_execution_errors_dto import DataservicesQueryQueryExecutionErrorsDTO +from visier_platform_sdk.models.dataservices_query_query_execution_options_dto import DataservicesQueryQueryExecutionOptionsDTO +from visier_platform_sdk.models.dataservices_query_query_filter_dto import DataservicesQueryQueryFilterDTO +from visier_platform_sdk.models.dataservices_query_query_member_map_property_dto import DataservicesQueryQueryMemberMapPropertyDTO +from visier_platform_sdk.models.dataservices_query_query_member_map_selection_dto import DataservicesQueryQueryMemberMapSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_numeric_ranges_dto import DataservicesQueryQueryNumericRangesDTO +from visier_platform_sdk.models.dataservices_query_query_parameter_value_dto import DataservicesQueryQueryParameterValueDTO +from visier_platform_sdk.models.dataservices_query_query_property_dto import DataservicesQueryQueryPropertyDTO +from visier_platform_sdk.models.dataservices_query_query_time_interval_dto import DataservicesQueryQueryTimeIntervalDTO +from visier_platform_sdk.models.dataservices_query_query_time_intervals_dto import DataservicesQueryQueryTimeIntervalsDTO +from visier_platform_sdk.models.dataservices_query_snapshot_query_execution_dto import DataservicesQuerySnapshotQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_snapshot_query_execution_options_dto import DataservicesQuerySnapshotQueryExecutionOptionsDTO +from visier_platform_sdk.models.dataservices_query_sort_option_dto import DataservicesQuerySortOptionDTO +from visier_platform_sdk.models.dataservices_query_sql_like_query_execution_dto import DataservicesQuerySqlLikeQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_time_shift_dto import DataservicesQueryTimeShiftDTO +from visier_platform_sdk.models.description_entry import DescriptionEntry +from visier_platform_sdk.models.designer_adp_auth_params_dto import DesignerAdpAuthParamsDTO +from visier_platform_sdk.models.designer_api_analytic_object_filter_dto import DesignerApiAnalyticObjectFilterDTO +from visier_platform_sdk.models.designer_api_calculation_concept_configuration_dto import DesignerApiCalculationConceptConfigurationDTO +from visier_platform_sdk.models.designer_api_calculation_concept_configuration_map_dto import DesignerApiCalculationConceptConfigurationMapDTO +from visier_platform_sdk.models.designer_api_calculation_concept_dto import DesignerApiCalculationConceptDTO +from visier_platform_sdk.models.designer_api_calculation_concept_list_dto import DesignerApiCalculationConceptListDTO +from visier_platform_sdk.models.designer_api_concept_configuration_result_dto import DesignerApiConceptConfigurationResultDTO +from visier_platform_sdk.models.designer_api_dimension_filter_dto import DesignerApiDimensionFilterDTO +from visier_platform_sdk.models.designer_api_dimension_member_dto import DesignerApiDimensionMemberDTO +from visier_platform_sdk.models.designer_api_perspective_configuration_dto import DesignerApiPerspectiveConfigurationDTO +from visier_platform_sdk.models.designer_api_perspective_node_dto import DesignerApiPerspectiveNodeDTO +from visier_platform_sdk.models.designer_api_selection_concept_configuration_dto import DesignerApiSelectionConceptConfigurationDTO +from visier_platform_sdk.models.designer_api_selection_concept_configuration_map_dto import DesignerApiSelectionConceptConfigurationMapDTO +from visier_platform_sdk.models.designer_api_selection_concept_dto import DesignerApiSelectionConceptDTO +from visier_platform_sdk.models.designer_api_selection_concept_list_dto import DesignerApiSelectionConceptListDTO +from visier_platform_sdk.models.designer_bamboo_auth_params_dto import DesignerBambooAuthParamsDTO +from visier_platform_sdk.models.designer_basic_s3_auth_params_dto import DesignerBasicS3AuthParamsDTO +from visier_platform_sdk.models.designer_big_query_auth_params_dto import DesignerBigQueryAuthParamsDTO +from visier_platform_sdk.models.designer_big_query_service_account_params_dto import DesignerBigQueryServiceAccountParamsDTO +from visier_platform_sdk.models.designer_copy_s3_auth_params_dto import DesignerCopyS3AuthParamsDTO +from visier_platform_sdk.models.designer_credential_creation_api_response_dto import DesignerCredentialCreationAPIResponseDTO +from visier_platform_sdk.models.designer_crypto_generate_key_request_dto import DesignerCryptoGenerateKeyRequestDTO +from visier_platform_sdk.models.designer_crypto_key_pair_delete_response_dto import DesignerCryptoKeyPairDeleteResponseDTO +from visier_platform_sdk.models.designer_crypto_key_pair_generate_request_dto import DesignerCryptoKeyPairGenerateRequestDTO +from visier_platform_sdk.models.designer_crypto_public_key_dto import DesignerCryptoPublicKeyDTO +from visier_platform_sdk.models.designer_crypto_public_keys_dto import DesignerCryptoPublicKeysDTO +from visier_platform_sdk.models.designer_crypto_tenant_encryption_key_dto import DesignerCryptoTenantEncryptionKeyDTO +from visier_platform_sdk.models.designer_crypto_tenant_encryption_key_details_dto import DesignerCryptoTenantEncryptionKeyDetailsDTO +from visier_platform_sdk.models.designer_data_provider_auth_information_dto import DesignerDataProviderAuthInformationDTO +from visier_platform_sdk.models.designer_data_provider_auth_params_dto import DesignerDataProviderAuthParamsDTO +from visier_platform_sdk.models.designer_data_provider_basic_information_dto import DesignerDataProviderBasicInformationDTO +from visier_platform_sdk.models.designer_data_provider_basic_metadata_dto import DesignerDataProviderBasicMetadataDTO +from visier_platform_sdk.models.designer_data_version_export_column_dto import DesignerDataVersionExportColumnDTO +from visier_platform_sdk.models.designer_data_version_export_dto import DesignerDataVersionExportDTO +from visier_platform_sdk.models.designer_data_version_export_data_version_summary_dto import DesignerDataVersionExportDataVersionSummaryDTO +from visier_platform_sdk.models.designer_data_version_export_data_versions_dto import DesignerDataVersionExportDataVersionsDTO +from visier_platform_sdk.models.designer_data_version_export_file_dto import DesignerDataVersionExportFileDTO +from visier_platform_sdk.models.designer_data_version_export_job_status_dto import DesignerDataVersionExportJobStatusDTO +from visier_platform_sdk.models.designer_data_version_export_part_file_dto import DesignerDataVersionExportPartFileDTO +from visier_platform_sdk.models.designer_data_version_export_schedule_job_request_dto import DesignerDataVersionExportScheduleJobRequestDTO +from visier_platform_sdk.models.designer_data_version_export_schedule_job_response_dto import DesignerDataVersionExportScheduleJobResponseDTO +from visier_platform_sdk.models.designer_data_version_export_table_dto import DesignerDataVersionExportTableDTO +from visier_platform_sdk.models.designer_data_version_exports_dto import DesignerDataVersionExportsDTO +from visier_platform_sdk.models.designer_databricks_auth_params_dto import DesignerDatabricksAuthParamsDTO +from visier_platform_sdk.models.designer_dayforce_v2_auth_params_dto import DesignerDayforceV2AuthParamsDTO +from visier_platform_sdk.models.designer_dimensions_auth_params_dto import DesignerDimensionsAuthParamsDTO +from visier_platform_sdk.models.designer_download_source_files_dto import DesignerDownloadSourceFilesDTO +from visier_platform_sdk.models.designer_download_source_files_response_dto import DesignerDownloadSourceFilesResponseDTO +from visier_platform_sdk.models.designer_extractor_credential_apidto import DesignerExtractorCredentialAPIDTO +from visier_platform_sdk.models.designer_extractor_credentials_apidto import DesignerExtractorCredentialsAPIDTO +from visier_platform_sdk.models.designer_fusion_auth_params_dto import DesignerFusionAuthParamsDTO +from visier_platform_sdk.models.designer_gong_auth_params_dto import DesignerGongAuthParamsDTO +from visier_platform_sdk.models.designer_google_sheets_auth_params_dto import DesignerGoogleSheetsAuthParamsDTO +from visier_platform_sdk.models.designer_google_workspace_auth_params_dto import DesignerGoogleWorkspaceAuthParamsDTO +from visier_platform_sdk.models.designer_greenhouse_auth_params_dto import DesignerGreenhouseAuthParamsDTO +from visier_platform_sdk.models.designer_icims_auth_params_dto import DesignerIcimsAuthParamsDTO +from visier_platform_sdk.models.designer_internal_s3_auth_params_dto import DesignerInternalS3AuthParamsDTO +from visier_platform_sdk.models.designer_jdbc_auth_params_dto import DesignerJdbcAuthParamsDTO +from visier_platform_sdk.models.designer_jira_auth_params_dto import DesignerJiraAuthParamsDTO +from visier_platform_sdk.models.designer_jira_connect_params_dto import DesignerJiraConnectParamsDTO +from visier_platform_sdk.models.designer_lever_auth_params_dto import DesignerLeverAuthParamsDTO +from visier_platform_sdk.models.designer_medallia_auth_params_dto import DesignerMedalliaAuthParamsDTO +from visier_platform_sdk.models.designer_microsoft365_auth_params_dto import DesignerMicrosoft365AuthParamsDTO +from visier_platform_sdk.models.designer_module_settings_dto import DesignerModuleSettingsDTO +from visier_platform_sdk.models.designer_my_sql_auth_params_dto import DesignerMySqlAuthParamsDTO +from visier_platform_sdk.models.designer_namely_auth_params_dto import DesignerNamelyAuthParamsDTO +from visier_platform_sdk.models.designer_oracle_db_auth_params_dto import DesignerOracleDbAuthParamsDTO +from visier_platform_sdk.models.designer_push_data_column_definition_dto import DesignerPushDataColumnDefinitionDTO +from visier_platform_sdk.models.designer_push_data_source_definition_dto import DesignerPushDataSourceDefinitionDTO +from visier_platform_sdk.models.designer_push_data_source_definitions_dto import DesignerPushDataSourceDefinitionsDTO +from visier_platform_sdk.models.designer_qualtrics_auth_params_dto import DesignerQualtricsAuthParamsDTO +from visier_platform_sdk.models.designer_redshift_auth_params_dto import DesignerRedshiftAuthParamsDTO +from visier_platform_sdk.models.designer_salesforce_auth_params_dto import DesignerSalesforceAuthParamsDTO +from visier_platform_sdk.models.designer_salesforce_v2_auth_params_dto import DesignerSalesforceV2AuthParamsDTO +from visier_platform_sdk.models.designer_service_now_auth_params_dto import DesignerServiceNowAuthParamsDTO +from visier_platform_sdk.models.designer_service_now_v2_auth_params_dto import DesignerServiceNowV2AuthParamsDTO +from visier_platform_sdk.models.designer_slack_auth_params_dto import DesignerSlackAuthParamsDTO +from visier_platform_sdk.models.designer_snowflake_auth_params_dto import DesignerSnowflakeAuthParamsDTO +from visier_platform_sdk.models.designer_sql_server_auth_params_dto import DesignerSqlServerAuthParamsDTO +from visier_platform_sdk.models.designer_subject_missing_access_dto import DesignerSubjectMissingAccessDTO +from visier_platform_sdk.models.designer_success_factors_auth_params_dto import DesignerSuccessFactorsAuthParamsDTO +from visier_platform_sdk.models.designer_success_factors_o_auth_params_dto import DesignerSuccessFactorsOAuthParamsDTO +from visier_platform_sdk.models.designer_tenant_module_dto import DesignerTenantModuleDTO +from visier_platform_sdk.models.designer_ultimate_auth_params_dto import DesignerUltimateAuthParamsDTO +from visier_platform_sdk.models.designer_webhook_webhook_basic_auth_credential_dto import DesignerWebhookWebhookBasicAuthCredentialDTO +from visier_platform_sdk.models.designer_webhook_webhook_credentials_dto import DesignerWebhookWebhookCredentialsDTO +from visier_platform_sdk.models.designer_webhook_webhook_dto import DesignerWebhookWebhookDTO +from visier_platform_sdk.models.designer_webhook_webhook_details_dto import DesignerWebhookWebhookDetailsDTO +from visier_platform_sdk.models.designer_webhook_webhook_event_type_dto import DesignerWebhookWebhookEventTypeDTO +from visier_platform_sdk.models.designer_webhook_webhook_message_response_dto import DesignerWebhookWebhookMessageResponseDTO +from visier_platform_sdk.models.designer_webhook_webhook_request_dto import DesignerWebhookWebhookRequestDTO +from visier_platform_sdk.models.designer_webhook_webhooks_dto import DesignerWebhookWebhooksDTO +from visier_platform_sdk.models.designer_willow_auth_params_dto import DesignerWillowAuthParamsDTO +from visier_platform_sdk.models.designer_workday_auth_params_dto import DesignerWorkdayAuthParamsDTO +from visier_platform_sdk.models.designer_workday_o_auth_params_dto import DesignerWorkdayOAuthParamsDTO +from visier_platform_sdk.models.designer_workday_raas_auth_params_dto import DesignerWorkdayRaasAuthParamsDTO +from visier_platform_sdk.models.designer_workday_refresh_token_params_dto import DesignerWorkdayRefreshTokenParamsDTO +from visier_platform_sdk.models.designer_zoom_auth_params_dto import DesignerZoomAuthParamsDTO +from visier_platform_sdk.models.dimension_member import DimensionMember +from visier_platform_sdk.models.direct_data_upload_file_response_dto import DirectDataUploadFileResponseDTO +from visier_platform_sdk.models.dp_automation_metric_validation_summary_dto import DpAutomationMetricValidationSummaryDTO +from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_dto import DpAutomationTenantPreviewEntriesSummaryDTO +from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_list_dto import DpAutomationTenantPreviewEntriesSummaryListDTO +from visier_platform_sdk.models.dp_cancel_job_batch_from_job_id_dto import DpCancelJobBatchFromJobIdDTO +from visier_platform_sdk.models.dp_job_cancellation_result_dto import DpJobCancellationResultDTO +from visier_platform_sdk.models.dp_job_cancellation_results_dto import DpJobCancellationResultsDTO +from visier_platform_sdk.models.dv_export_status import DvExportStatus +from visier_platform_sdk.models.extracted_skill import ExtractedSkill +from visier_platform_sdk.models.generate_impersonation_token_request import GenerateImpersonationTokenRequest +from visier_platform_sdk.models.google_protobuf_any import GoogleProtobufAny +from visier_platform_sdk.models.hierarchy import Hierarchy +from visier_platform_sdk.models.job import Job +from visier_platform_sdk.models.job_entry import JobEntry +from visier_platform_sdk.models.job_feedback_input import JobFeedbackInput +from visier_platform_sdk.models.job_search_failure_output import JobSearchFailureOutput +from visier_platform_sdk.models.job_search_input import JobSearchInput +from visier_platform_sdk.models.job_search_output import JobSearchOutput +from visier_platform_sdk.models.job_standardization_input import JobStandardizationInput +from visier_platform_sdk.models.job_standardization_input_skills import JobStandardizationInputSkills +from visier_platform_sdk.models.location_search_failure_output import LocationSearchFailureOutput +from visier_platform_sdk.models.location_search_input import LocationSearchInput +from visier_platform_sdk.models.location_search_input1 import LocationSearchInput1 +from visier_platform_sdk.models.location_search_output import LocationSearchOutput +from visier_platform_sdk.models.location_search_successful_output import LocationSearchSuccessfulOutput +from visier_platform_sdk.models.output_entry import OutputEntry +from visier_platform_sdk.models.output_entry1 import OutputEntry1 +from visier_platform_sdk.models.output_entry1_matches_inner import OutputEntry1MatchesInner +from visier_platform_sdk.models.plan_data_load_change_dto import PlanDataLoadChangeDTO +from visier_platform_sdk.models.plan_data_load_change_list_dto import PlanDataLoadChangeListDTO +from visier_platform_sdk.models.plan_data_upload_response_dto import PlanDataUploadResponseDTO +from visier_platform_sdk.models.plan_row_data_load_response_dto import PlanRowDataLoadResponseDTO +from visier_platform_sdk.models.planning_get_plan_list_response_dto import PlanningGetPlanListResponseDTO +from visier_platform_sdk.models.planning_plan_data_load_error_dto import PlanningPlanDataLoadErrorDTO +from visier_platform_sdk.models.planning_plan_info_dto import PlanningPlanInfoDTO +from visier_platform_sdk.models.planning_plan_item_dto import PlanningPlanItemDTO +from visier_platform_sdk.models.planning_plan_schema_dto import PlanningPlanSchemaDTO +from visier_platform_sdk.models.planning_plan_segment_level_dto import PlanningPlanSegmentLevelDTO +from visier_platform_sdk.models.planning_plan_segment_level_member_dto import PlanningPlanSegmentLevelMemberDTO +from visier_platform_sdk.models.planning_plan_segment_level_member_list_dto import PlanningPlanSegmentLevelMemberListDTO +from visier_platform_sdk.models.planning_plan_time_period_dto import PlanningPlanTimePeriodDTO +from visier_platform_sdk.models.planning_plan_with_schema_dto import PlanningPlanWithSchemaDTO +from visier_platform_sdk.models.planning_scenario_info_dto import PlanningScenarioInfoDTO +from visier_platform_sdk.models.salary_benchmark_input import SalaryBenchmarkInput +from visier_platform_sdk.models.salary_benchmarks_batch_processing_failure_output import SalaryBenchmarksBatchProcessingFailureOutput +from visier_platform_sdk.models.salary_benchmarks_batch_processing_outputs import SalaryBenchmarksBatchProcessingOutputs +from visier_platform_sdk.models.salary_benchmarks_batch_processing_successful_output import SalaryBenchmarksBatchProcessingSuccessfulOutput +from visier_platform_sdk.models.servicing_accessible_tenant_profile_assignment_request_dto import ServicingAccessibleTenantProfileAssignmentRequestDTO +from visier_platform_sdk.models.servicing_accessible_tenant_profile_assignment_response_dto import ServicingAccessibleTenantProfileAssignmentResponseDTO +from visier_platform_sdk.models.servicing_accessible_tenant_profile_revoke_request_dto import ServicingAccessibleTenantProfileRevokeRequestDTO +from visier_platform_sdk.models.servicing_accessible_tenant_profile_revoke_response_dto import ServicingAccessibleTenantProfileRevokeResponseDTO +from visier_platform_sdk.models.servicing_additional_capabilities_dto import ServicingAdditionalCapabilitiesDTO +from visier_platform_sdk.models.servicing_admin_capability_config_dto import ServicingAdminCapabilityConfigDTO +from visier_platform_sdk.models.servicing_all_permissions_assigned_for_local_tenant_dto import ServicingAllPermissionsAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_all_profile_assigned_for_accessible_tenant_dto import ServicingAllProfileAssignedForAccessibleTenantDTO +from visier_platform_sdk.models.servicing_all_profile_assigned_for_local_tenant_dto import ServicingAllProfileAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_all_user_groups_assigned_for_local_tenant_dto import ServicingAllUserGroupsAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_all_users_get_api_response_dto import ServicingAllUsersGetAPIResponseDTO +from visier_platform_sdk.models.servicing_analytic_object_dto import ServicingAnalyticObjectDTO +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_permission_dto import ServicingAssignRevokePermissionByPermissionDTO +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_tenant_dto import ServicingAssignRevokePermissionByTenantDTO +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_user_dto import ServicingAssignRevokePermissionByUserDTO +from visier_platform_sdk.models.servicing_assign_revoke_permission_request_dto import ServicingAssignRevokePermissionRequestDTO +from visier_platform_sdk.models.servicing_assign_revoke_permissions_request_dto import ServicingAssignRevokePermissionsRequestDTO +from visier_platform_sdk.models.servicing_assign_revoke_permissions_response_dto import ServicingAssignRevokePermissionsResponseDTO +from visier_platform_sdk.models.servicing_bulk_data_access_set_response_dto import ServicingBulkDataAccessSetResponseDTO +from visier_platform_sdk.models.servicing_capabilities_dto import ServicingCapabilitiesDTO +from visier_platform_sdk.models.servicing_capability_dto import ServicingCapabilityDTO +from visier_platform_sdk.models.servicing_capability_group_dto import ServicingCapabilityGroupDTO +from visier_platform_sdk.models.servicing_commit_and_publish_operation_response_dto import ServicingCommitAndPublishOperationResponseDTO +from visier_platform_sdk.models.servicing_commit_dto import ServicingCommitDTO +from visier_platform_sdk.models.servicing_content_package_dto import ServicingContentPackageDTO +from visier_platform_sdk.models.servicing_create_data_access_set_request_dto import ServicingCreateDataAccessSetRequestDTO +from visier_platform_sdk.models.servicing_data_access_set_dto import ServicingDataAccessSetDTO +from visier_platform_sdk.models.servicing_data_access_set_error_dto import ServicingDataAccessSetErrorDTO +from visier_platform_sdk.models.servicing_data_access_set_failure_dto import ServicingDataAccessSetFailureDTO +from visier_platform_sdk.models.servicing_data_access_set_success_dto import ServicingDataAccessSetSuccessDTO +from visier_platform_sdk.models.servicing_data_categories_response_dto import ServicingDataCategoriesResponseDTO +from visier_platform_sdk.models.servicing_data_category_response_dto import ServicingDataCategoryResponseDTO +from visier_platform_sdk.models.servicing_data_security_profile_dto import ServicingDataSecurityProfileDTO +from visier_platform_sdk.models.servicing_delete_permissions_request_dto import ServicingDeletePermissionsRequestDTO +from visier_platform_sdk.models.servicing_dimension_filter_dto import ServicingDimensionFilterDTO +from visier_platform_sdk.models.servicing_direct_data_job_config_dto import ServicingDirectDataJobConfigDTO +from visier_platform_sdk.models.servicing_direct_data_job_status_response_dto import ServicingDirectDataJobStatusResponseDTO +from visier_platform_sdk.models.servicing_direct_data_list_transactions_response_dto import ServicingDirectDataListTransactionsResponseDTO +from visier_platform_sdk.models.servicing_direct_data_load_config_dto import ServicingDirectDataLoadConfigDTO +from visier_platform_sdk.models.servicing_direct_data_schema_dto import ServicingDirectDataSchemaDTO +from visier_platform_sdk.models.servicing_direct_data_schema_field_dto import ServicingDirectDataSchemaFieldDTO +from visier_platform_sdk.models.servicing_direct_data_transaction_dto import ServicingDirectDataTransactionDTO +from visier_platform_sdk.models.servicing_direct_data_transaction_start_response_dto import ServicingDirectDataTransactionStartResponseDTO +from visier_platform_sdk.models.servicing_direct_data_upload_file_response_dto import ServicingDirectDataUploadFileResponseDTO +from visier_platform_sdk.models.servicing_document_search_link_dto import ServicingDocumentSearchLinkDTO +from visier_platform_sdk.models.servicing_dynamic_dimension_filter_dto import ServicingDynamicDimensionFilterDTO +from visier_platform_sdk.models.servicing_dynamic_property_mapping_dto import ServicingDynamicPropertyMappingDTO +from visier_platform_sdk.models.servicing_error_dto import ServicingErrorDTO +from visier_platform_sdk.models.servicing_export_production_versions_api_operation_parameters_dto import ServicingExportProductionVersionsAPIOperationParametersDTO +from visier_platform_sdk.models.servicing_failed_accessible_tenant_profile_assignment_dto import ServicingFailedAccessibleTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_failed_local_tenant_profile_assignment_dto import ServicingFailedLocalTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_failed_local_tenant_profile_revoke_dto import ServicingFailedLocalTenantProfileRevokeDTO +from visier_platform_sdk.models.servicing_get_capabilities_api_response_dto import ServicingGetCapabilitiesAPIResponseDTO +from visier_platform_sdk.models.servicing_get_content_packages_api_response_dto import ServicingGetContentPackagesAPIResponseDTO +from visier_platform_sdk.models.servicing_get_data_access_sets_api_response_dto import ServicingGetDataAccessSetsAPIResponseDTO +from visier_platform_sdk.models.servicing_get_data_security_objects_api_response_dto import ServicingGetDataSecurityObjectsAPIResponseDTO +from visier_platform_sdk.models.servicing_get_permissions_api_response_dto import ServicingGetPermissionsAPIResponseDTO +from visier_platform_sdk.models.servicing_get_production_versions_api_response_dto import ServicingGetProductionVersionsAPIResponseDTO +from visier_platform_sdk.models.servicing_get_projects_api_response_dto import ServicingGetProjectsAPIResponseDTO +from visier_platform_sdk.models.servicing_hierarchy_property_dto import ServicingHierarchyPropertyDTO +from visier_platform_sdk.models.servicing_inherited_access_config_dto import ServicingInheritedAccessConfigDTO +from visier_platform_sdk.models.servicing_inherited_reference_member_filter_config_dto import ServicingInheritedReferenceMemberFilterConfigDTO +from visier_platform_sdk.models.servicing_job_id_response import ServicingJobIdResponse +from visier_platform_sdk.models.servicing_last_login_dto import ServicingLastLoginDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_assignment_request_dto import ServicingLocalTenantProfileAssignmentRequestDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_assignment_response_dto import ServicingLocalTenantProfileAssignmentResponseDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_revoke_request_dto import ServicingLocalTenantProfileRevokeRequestDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_revoke_response_dto import ServicingLocalTenantProfileRevokeResponseDTO +from visier_platform_sdk.models.servicing_member_filter_config_dto import ServicingMemberFilterConfigDTO +from visier_platform_sdk.models.servicing_member_selection_dto import ServicingMemberSelectionDTO +from visier_platform_sdk.models.servicing_objectconfiguration_calculated_property_type_dto import ServicingObjectconfigurationCalculatedPropertyTypeDTO +from visier_platform_sdk.models.servicing_objectconfiguration_dependent_dto import ServicingObjectconfigurationDependentDTO +from visier_platform_sdk.models.servicing_objectconfiguration_dimension_change_definition_dto import ServicingObjectconfigurationDimensionChangeDefinitionDTO +from visier_platform_sdk.models.servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto import ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO +from visier_platform_sdk.models.servicing_objectconfiguration_dimensions_change_definitions_dto import ServicingObjectconfigurationDimensionsChangeDefinitionsDTO +from visier_platform_sdk.models.servicing_objectconfiguration_object_change_failure_dto import ServicingObjectconfigurationObjectChangeFailureDTO +from visier_platform_sdk.models.servicing_objectconfiguration_object_change_success_dto import ServicingObjectconfigurationObjectChangeSuccessDTO +from visier_platform_sdk.models.servicing_objectconfiguration_objects_bulk_change_response_dto import ServicingObjectconfigurationObjectsBulkChangeResponseDTO +from visier_platform_sdk.models.servicing_objectconfiguration_properties_change_definitions_dto import ServicingObjectconfigurationPropertiesChangeDefinitionsDTO +from visier_platform_sdk.models.servicing_objectconfiguration_properties_delete_definitions_dto import ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_bulk_delete_response_dto import ServicingObjectconfigurationPropertyBulkDeleteResponseDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_change_definition_dto import ServicingObjectconfigurationPropertyChangeDefinitionDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_change_definitions_by_tenant_dto import ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_definitions_by_tenant_dto import ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_failure_dto import ServicingObjectconfigurationPropertyDeleteFailureDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_success_dto import ServicingObjectconfigurationPropertyDeleteSuccessDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_type_dto import ServicingObjectconfigurationPropertyTypeDTO +from visier_platform_sdk.models.servicing_objectconfiguration_simple_property_type_dto import ServicingObjectconfigurationSimplePropertyTypeDTO +from visier_platform_sdk.models.servicing_objectconfiguration_tags_dto import ServicingObjectconfigurationTagsDTO +from visier_platform_sdk.models.servicing_permission_assigned_by_tenant_dto import ServicingPermissionAssignedByTenantDTO +from visier_platform_sdk.models.servicing_permission_assigned_for_local_tenant_dto import ServicingPermissionAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_permission_assigned_user_dto import ServicingPermissionAssignedUserDTO +from visier_platform_sdk.models.servicing_permission_assigned_users_dto import ServicingPermissionAssignedUsersDTO +from visier_platform_sdk.models.servicing_permission_bulk_operation_response_dto import ServicingPermissionBulkOperationResponseDTO +from visier_platform_sdk.models.servicing_permission_dto import ServicingPermissionDTO +from visier_platform_sdk.models.servicing_permission_error_dto import ServicingPermissionErrorDTO +from visier_platform_sdk.models.servicing_permission_failure_dto import ServicingPermissionFailureDTO +from visier_platform_sdk.models.servicing_permission_success_dto import ServicingPermissionSuccessDTO +from visier_platform_sdk.models.servicing_production_version_api_operation_request_dto import ServicingProductionVersionAPIOperationRequestDTO +from visier_platform_sdk.models.servicing_production_version_api_operation_response_dto import ServicingProductionVersionAPIOperationResponseDTO +from visier_platform_sdk.models.servicing_production_versions_api_operation_request_dto import ServicingProductionVersionsAPIOperationRequestDTO +from visier_platform_sdk.models.servicing_production_versions_api_operation_response_dto import ServicingProductionVersionsAPIOperationResponseDTO +from visier_platform_sdk.models.servicing_profile_assigned_for_accessible_tenant_dto import ServicingProfileAssignedForAccessibleTenantDTO +from visier_platform_sdk.models.servicing_profile_assigned_for_local_tenant_dto import ServicingProfileAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_profile_get_api_response_dto import ServicingProfileGetAPIResponseDTO +from visier_platform_sdk.models.servicing_profiles_get_api_response_dto import ServicingProfilesGetAPIResponseDTO +from visier_platform_sdk.models.servicing_project_commits_api_response_dto import ServicingProjectCommitsAPIResponseDTO +from visier_platform_sdk.models.servicing_project_dto import ServicingProjectDTO +from visier_platform_sdk.models.servicing_project_operation_request_dto import ServicingProjectOperationRequestDTO +from visier_platform_sdk.models.servicing_project_operation_response_dto import ServicingProjectOperationResponseDTO +from visier_platform_sdk.models.servicing_property_access_config_dto import ServicingPropertyAccessConfigDTO +from visier_platform_sdk.models.servicing_property_set_config_dto import ServicingPropertySetConfigDTO +from visier_platform_sdk.models.servicing_question_categories_api_response_dto import ServicingQuestionCategoriesAPIResponseDTO +from visier_platform_sdk.models.servicing_question_category_api_response_dto import ServicingQuestionCategoryAPIResponseDTO +from visier_platform_sdk.models.servicing_reduced_error_dto import ServicingReducedErrorDTO +from visier_platform_sdk.models.servicing_reduced_tenant_code_error_dto import ServicingReducedTenantCodeErrorDTO +from visier_platform_sdk.models.servicing_reduced_user_id_error_dto import ServicingReducedUserIdErrorDTO +from visier_platform_sdk.models.servicing_related_analytic_object_dto import ServicingRelatedAnalyticObjectDTO +from visier_platform_sdk.models.servicing_role_modules_config_dto import ServicingRoleModulesConfigDTO +from visier_platform_sdk.models.servicing_sample_question_api_response_dto import ServicingSampleQuestionAPIResponseDTO +from visier_platform_sdk.models.servicing_sample_questions_api_response_dto import ServicingSampleQuestionsAPIResponseDTO +from visier_platform_sdk.models.servicing_securable_dimension_dto import ServicingSecurableDimensionDTO +from visier_platform_sdk.models.servicing_securable_property_dto import ServicingSecurablePropertyDTO +from visier_platform_sdk.models.servicing_servicing_capability_proto_enum_access_lookup_dto import ServicingServicingCapabilityProtoEnumAccessLookupDTO +from visier_platform_sdk.models.servicing_shareable_data_access_set import ServicingShareableDataAccessSet +from visier_platform_sdk.models.servicing_simple_document_header_search_response_dto import ServicingSimpleDocumentHeaderSearchResponseDTO +from visier_platform_sdk.models.servicing_simple_document_header_search_result_dto import ServicingSimpleDocumentHeaderSearchResultDTO +from visier_platform_sdk.models.servicing_sources_api_operation_request_dto import ServicingSourcesAPIOperationRequestDTO +from visier_platform_sdk.models.servicing_static_dimension_filter_dto import ServicingStaticDimensionFilterDTO +from visier_platform_sdk.models.servicing_successful_accessible_tenant_profile_assignment_dto import ServicingSuccessfulAccessibleTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_successful_local_tenant_profile_assignment_dto import ServicingSuccessfulLocalTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_target_tenant_code_dto import ServicingTargetTenantCodeDTO +from visier_platform_sdk.models.servicing_tenant_code_error_dto import ServicingTenantCodeErrorDTO +from visier_platform_sdk.models.servicing_tenant_data_upload_status_response_dto import ServicingTenantDataUploadStatusResponseDTO +from visier_platform_sdk.models.servicing_tenant_data_upload_update_status_response_dto import ServicingTenantDataUploadUpdateStatusResponseDTO +from visier_platform_sdk.models.servicing_tenant_data_uploads_list_response_dto import ServicingTenantDataUploadsListResponseDTO +from visier_platform_sdk.models.servicing_tenant_data_uploads_response_dto import ServicingTenantDataUploadsResponseDTO +from visier_platform_sdk.models.servicing_tenant_data_uploads_update_response_dto import ServicingTenantDataUploadsUpdateResponseDTO +from visier_platform_sdk.models.servicing_user_creation_api_request_dto import ServicingUserCreationAPIRequestDTO +from visier_platform_sdk.models.servicing_user_get_api_response_dto import ServicingUserGetAPIResponseDTO +from visier_platform_sdk.models.servicing_user_group_assigned_for_local_tenant_dto import ServicingUserGroupAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_user_group_assignment_dto import ServicingUserGroupAssignmentDTO +from visier_platform_sdk.models.servicing_user_id_error_dto import ServicingUserIdErrorDTO +from visier_platform_sdk.models.servicing_user_property_dto import ServicingUserPropertyDTO +from visier_platform_sdk.models.servicing_user_update_api_request_dto import ServicingUserUpdateAPIRequestDTO +from visier_platform_sdk.models.servicing_users_api_error_message_dto import ServicingUsersAPIErrorMessageDTO +from visier_platform_sdk.models.servicing_users_api_failure_dto import ServicingUsersAPIFailureDTO +from visier_platform_sdk.models.servicing_users_api_response_dto import ServicingUsersAPIResponseDTO +from visier_platform_sdk.models.servicing_users_api_success_dto import ServicingUsersAPISuccessDTO +from visier_platform_sdk.models.servicing_users_creation_api_request_dto import ServicingUsersCreationAPIRequestDTO +from visier_platform_sdk.models.servicing_users_delete_api_request_dto import ServicingUsersDeleteAPIRequestDTO +from visier_platform_sdk.models.servicing_users_update_api_request_dto import ServicingUsersUpdateAPIRequestDTO +from visier_platform_sdk.models.servicing_users_update_api_user_dto import ServicingUsersUpdateAPIUserDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_definition_dto import ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_request_dto import ServicingV2ObjectconfigurationAnalyticObjectRequestDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_with_context_dto import ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_basic_information_dto import ServicingV2ObjectconfigurationBasicInformationDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_bulk_change_response_dto import ServicingV2ObjectconfigurationBulkChangeResponseDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_calculated_property_type_dto import ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_definition_dto import ServicingV2ObjectconfigurationConceptDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_delete_request_dto import ServicingV2ObjectconfigurationConceptDeleteRequestDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_delete_with_context_dto import ServicingV2ObjectconfigurationConceptDeleteWithContextDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_request_dto import ServicingV2ObjectconfigurationConceptRequestDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_response_dto import ServicingV2ObjectconfigurationConceptResponseDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_type_details_dto import ServicingV2ObjectconfigurationConceptTypeDetailsDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_with_context_dto import ServicingV2ObjectconfigurationConceptWithContextDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_execution_context_dto import ServicingV2ObjectconfigurationExecutionContextDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_failed_change_dto import ServicingV2ObjectconfigurationFailedChangeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_metric_definition_dto import ServicingV2ObjectconfigurationMetricDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_metric_type_details_dto import ServicingV2ObjectconfigurationMetricTypeDetailsDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_object_id_dto import ServicingV2ObjectconfigurationObjectIdDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_definition_dto import ServicingV2ObjectconfigurationProcessConceptDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_member_dto import ServicingV2ObjectconfigurationProcessConceptMemberDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_member_list_dto import ServicingV2ObjectconfigurationProcessConceptMemberListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_metric_definition_dto import ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_metric_list_dto import ServicingV2ObjectconfigurationProcessConceptMetricListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_outcome_dto import ServicingV2ObjectconfigurationProcessConceptOutcomeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_outcome_list_dto import ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_property_list_dto import ServicingV2ObjectconfigurationProcessConceptPropertyListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_property_type_dto import ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_stage_dto import ServicingV2ObjectconfigurationProcessConceptStageDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_stage_list_dto import ServicingV2ObjectconfigurationProcessConceptStageListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_property_definition_dto import ServicingV2ObjectconfigurationPropertyDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_property_type_details_dto import ServicingV2ObjectconfigurationPropertyTypeDetailsDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_simple_property_type_dto import ServicingV2ObjectconfigurationSimplePropertyTypeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_successful_change_dto import ServicingV2ObjectconfigurationSuccessfulChangeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_synonym_list_dto import ServicingV2ObjectconfigurationSynonymListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_tag_reference_dto import ServicingV2ObjectconfigurationTagReferenceDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_tag_reference_list_dto import ServicingV2ObjectconfigurationTagReferenceListDTO +from visier_platform_sdk.models.servicing_vee_question_change_definition_dto import ServicingVeeQuestionChangeDefinitionDTO +from visier_platform_sdk.models.servicing_vee_question_change_definitions_by_tenant_dto import ServicingVeeQuestionChangeDefinitionsByTenantDTO +from visier_platform_sdk.models.servicing_vee_question_change_failure_dto import ServicingVeeQuestionChangeFailureDTO +from visier_platform_sdk.models.servicing_vee_question_change_success_dto import ServicingVeeQuestionChangeSuccessDTO +from visier_platform_sdk.models.servicing_vee_question_delete_definitions_by_tenant_dto import ServicingVeeQuestionDeleteDefinitionsByTenantDTO +from visier_platform_sdk.models.servicing_vee_questions_bulk_change_response_dto import ServicingVeeQuestionsBulkChangeResponseDTO +from visier_platform_sdk.models.servicing_vee_questions_change_definitions_dto import ServicingVeeQuestionsChangeDefinitionsDTO +from visier_platform_sdk.models.servicing_vee_questions_delete_definitions_dto import ServicingVeeQuestionsDeleteDefinitionsDTO +from visier_platform_sdk.models.skill import Skill +from visier_platform_sdk.models.skill_category import SkillCategory +from visier_platform_sdk.models.skill_category_entry import SkillCategoryEntry +from visier_platform_sdk.models.skill_entry import SkillEntry +from visier_platform_sdk.models.skill_extraction_input import SkillExtractionInput +from visier_platform_sdk.models.skill_group import SkillGroup +from visier_platform_sdk.models.skill_group_entry import SkillGroupEntry +from visier_platform_sdk.models.skill_match_input import SkillMatchInput +from visier_platform_sdk.models.source_import_result_summary_dto import SourceImportResultSummaryDTO +from visier_platform_sdk.models.sources_api_put_response_dto import SourcesAPIPutResponseDTO +from visier_platform_sdk.models.sql_like200_response import SqlLike200Response +from visier_platform_sdk.models.status import Status +from visier_platform_sdk.models.systemstatus_system_status_dto import SystemstatusSystemStatusDTO +from visier_platform_sdk.models.systemstatus_vee_status_dto import SystemstatusVeeStatusDTO +from visier_platform_sdk.models.table_response_dto import TableResponseDTO +from visier_platform_sdk.models.token_response import TokenResponse +from visier_platform_sdk.models.user_creation_api_response_dto import UserCreationAPIResponseDTO diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/__init__.py b/src/visier_platform_sdk/visier_platform_sdk/api/__init__.py new file mode 100644 index 0000000000..55482f1a60 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/__init__.py @@ -0,0 +1,42 @@ +# flake8: noqa + +# import apis into api package +from visier_platform_sdk.api.basic_authentication_api import BasicAuthenticationApi +from visier_platform_sdk.api.benchmarks_api import BenchmarksApi +from visier_platform_sdk.api.concepts_v2_api import ConceptsV2Api +from visier_platform_sdk.api.consolidated_analytics_api import ConsolidatedAnalyticsApi +from visier_platform_sdk.api.data_and_job_handling_api import DataAndJobHandlingApi +from visier_platform_sdk.api.data_intake_api import DataIntakeApi +from visier_platform_sdk.api.data_model_api import DataModelApi +from visier_platform_sdk.api.data_query_api import DataQueryApi +from visier_platform_sdk.api.data_upload_api import DataUploadApi +from visier_platform_sdk.api.data_version_export_api import DataVersionExportApi +from visier_platform_sdk.api.dimensions_api import DimensionsApi +from visier_platform_sdk.api.direct_data_intake_api import DirectDataIntakeApi +from visier_platform_sdk.api.email_domains_api import EmailDomainsApi +from visier_platform_sdk.api.encryption_keys_api import EncryptionKeysApi +from visier_platform_sdk.api.jobs_library_api import JobsLibraryApi +from visier_platform_sdk.api.network_subnets_api import NetworkSubnetsApi +from visier_platform_sdk.api.o_auth2_api import OAuth2Api +from visier_platform_sdk.api.object_configuration_api import ObjectConfigurationApi +from visier_platform_sdk.api.pgp_key_api import PGPKeyApi +from visier_platform_sdk.api.permissions_api import PermissionsApi +from visier_platform_sdk.api.planning_data_load_api import PlanningDataLoadApi +from visier_platform_sdk.api.production_versions_api import ProductionVersionsApi +from visier_platform_sdk.api.profiles_api import ProfilesApi +from visier_platform_sdk.api.projects_api import ProjectsApi +from visier_platform_sdk.api.release_version_configuration_api import ReleaseVersionConfigurationApi +from visier_platform_sdk.api.reporting_api import ReportingApi +from visier_platform_sdk.api.search_api import SearchApi +from visier_platform_sdk.api.skills_library_api import SkillsLibraryApi +from visier_platform_sdk.api.source_files_download_api import SourceFilesDownloadApi +from visier_platform_sdk.api.sources_api import SourcesApi +from visier_platform_sdk.api.system_status_api import SystemStatusApi +from visier_platform_sdk.api.tenants_v1_api import TenantsV1Api +from visier_platform_sdk.api.tenants_v2_api import TenantsV2Api +from visier_platform_sdk.api.user_groups_v2_api import UserGroupsV2Api +from visier_platform_sdk.api.users_v1_api import UsersV1Api +from visier_platform_sdk.api.users_v2_api import UsersV2Api +from visier_platform_sdk.api.vee_api import VeeApi +from visier_platform_sdk.api.webhooks_api import WebhooksApi + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/basic_authentication_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/basic_authentication_api.py new file mode 100644 index 0000000000..b5def65795 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/basic_authentication_api.py @@ -0,0 +1,625 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.generate_impersonation_token_request import GenerateImpersonationTokenRequest + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class BasicAuthenticationApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def a_sid_token_authentication( + self, + username: Annotated[Optional[StrictStr], Field(description="The unique identifier of the API user requesting a security token.")] = None, + password: Annotated[Optional[StrictStr], Field(description="The password that corresponds to the user making the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> str: + """Request a Visier authentication token + + Generate a secure ASID token. + + :param username: The unique identifier of the API user requesting a security token. + :type username: str + :param password: The password that corresponds to the user making the request. + :type password: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._a_sid_token_authentication_serialize( + username=username, + password=password, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def a_sid_token_authentication_with_http_info( + self, + username: Annotated[Optional[StrictStr], Field(description="The unique identifier of the API user requesting a security token.")] = None, + password: Annotated[Optional[StrictStr], Field(description="The password that corresponds to the user making the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[str]: + """Request a Visier authentication token + + Generate a secure ASID token. + + :param username: The unique identifier of the API user requesting a security token. + :type username: str + :param password: The password that corresponds to the user making the request. + :type password: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._a_sid_token_authentication_serialize( + username=username, + password=password, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def a_sid_token_authentication_without_preload_content( + self, + username: Annotated[Optional[StrictStr], Field(description="The unique identifier of the API user requesting a security token.")] = None, + password: Annotated[Optional[StrictStr], Field(description="The password that corresponds to the user making the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Request a Visier authentication token + + Generate a secure ASID token. + + :param username: The unique identifier of the API user requesting a security token. + :type username: str + :param password: The password that corresponds to the user making the request. + :type password: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._a_sid_token_authentication_serialize( + username=username, + password=password, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _a_sid_token_authentication_serialize( + self, + username, + password, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + if username is not None: + _form_params.append(('username', username)) + if password is not None: + _form_params.append(('password', password)) + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'text/plain' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/x-www-form-urlencoded' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/visierSecureToken', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def generate_impersonation_token( + self, + generate_impersonation_token_request: Annotated[GenerateImpersonationTokenRequest, Field(description="Request to generate an impersonation token.")], + target_tenant_id: Annotated[Optional[StrictStr], Field(description="The tenant ID to execute the call on.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> str: + """Request an impersonation token + + Generate an impersonation token for the given username. + + :param generate_impersonation_token_request: Request to generate an impersonation token. (required) + :type generate_impersonation_token_request: GenerateImpersonationTokenRequest + :param target_tenant_id: The tenant ID to execute the call on. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_impersonation_token_serialize( + generate_impersonation_token_request=generate_impersonation_token_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def generate_impersonation_token_with_http_info( + self, + generate_impersonation_token_request: Annotated[GenerateImpersonationTokenRequest, Field(description="Request to generate an impersonation token.")], + target_tenant_id: Annotated[Optional[StrictStr], Field(description="The tenant ID to execute the call on.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[str]: + """Request an impersonation token + + Generate an impersonation token for the given username. + + :param generate_impersonation_token_request: Request to generate an impersonation token. (required) + :type generate_impersonation_token_request: GenerateImpersonationTokenRequest + :param target_tenant_id: The tenant ID to execute the call on. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_impersonation_token_serialize( + generate_impersonation_token_request=generate_impersonation_token_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def generate_impersonation_token_without_preload_content( + self, + generate_impersonation_token_request: Annotated[GenerateImpersonationTokenRequest, Field(description="Request to generate an impersonation token.")], + target_tenant_id: Annotated[Optional[StrictStr], Field(description="The tenant ID to execute the call on.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Request an impersonation token + + Generate an impersonation token for the given username. + + :param generate_impersonation_token_request: Request to generate an impersonation token. (required) + :type generate_impersonation_token_request: GenerateImpersonationTokenRequest + :param target_tenant_id: The tenant ID to execute the call on. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_impersonation_token_serialize( + generate_impersonation_token_request=generate_impersonation_token_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _generate_impersonation_token_serialize( + self, + generate_impersonation_token_request, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if generate_impersonation_token_request is not None: + _body_params = generate_impersonation_token_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'text/plain' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/visierImpersonationToken', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/benchmarks_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/benchmarks_api.py new file mode 100644 index 0000000000..10127a2292 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/benchmarks_api.py @@ -0,0 +1,936 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import List, Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.benchmark_info import BenchmarkInfo +from visier_platform_sdk.models.benchmark_value import BenchmarkValue +from visier_platform_sdk.models.salary_benchmark_input import SalaryBenchmarkInput +from visier_platform_sdk.models.salary_benchmarks_batch_processing_outputs import SalaryBenchmarksBatchProcessingOutputs + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class BenchmarksApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def get_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[BenchmarkInfo]: + """Get benchmark metadata + + Retrieve metadata that summarizes the benchmark dataset and API such as the release date. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_info_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[BenchmarkInfo]", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_info_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[BenchmarkInfo]]: + """Get benchmark metadata + + Retrieve metadata that summarizes the benchmark dataset and API such as the release date. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_info_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[BenchmarkInfo]", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_info_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get benchmark metadata + + Retrieve metadata that summarizes the benchmark dataset and API such as the release date. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_info_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[BenchmarkInfo]", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_info_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/compensation-benchmarks/info', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_salary_benchmark( + self, + job: Annotated[StrictStr, Field(description="The job member ID. ")], + industry: Annotated[Optional[StrictStr], Field(description="The industry member ID. If the ID is not provided, the response returns the benchmark value across all industries. ")] = None, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If the NAICS code is not provided, the response returns the benchmark value across all industries. If both `naicsCode` and `industry` are provided, the response returns the benchmark value for the `industry` parameter. The entered `naicsCode` will not be applied. ")] = None, + location: Annotated[Optional[StrictStr], Field(description="The location member ID. If the ID is not provided, the response returns the benchmark value across all locations. ")] = None, + company_size: Annotated[Optional[StrictStr], Field(description="The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes. ")] = None, + career_level: Annotated[Optional[StrictStr], Field(description="The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BenchmarkValue: + """Get base salary benchmark value + + Retrieve the base salary benchmark value. + + :param job: The job member ID. (required) + :type job: str + :param industry: The industry member ID. If the ID is not provided, the response returns the benchmark value across all industries. + :type industry: str + :param naics_code: The North American Industry Classification System (NAICS) code. If the NAICS code is not provided, the response returns the benchmark value across all industries. If both `naicsCode` and `industry` are provided, the response returns the benchmark value for the `industry` parameter. The entered `naicsCode` will not be applied. + :type naics_code: str + :param location: The location member ID. If the ID is not provided, the response returns the benchmark value across all locations. + :type location: str + :param company_size: The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes. + :type company_size: str + :param career_level: The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. + :type career_level: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_salary_benchmark_serialize( + job=job, + industry=industry, + naics_code=naics_code, + location=location, + company_size=company_size, + career_level=career_level, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BenchmarkValue", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_salary_benchmark_with_http_info( + self, + job: Annotated[StrictStr, Field(description="The job member ID. ")], + industry: Annotated[Optional[StrictStr], Field(description="The industry member ID. If the ID is not provided, the response returns the benchmark value across all industries. ")] = None, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If the NAICS code is not provided, the response returns the benchmark value across all industries. If both `naicsCode` and `industry` are provided, the response returns the benchmark value for the `industry` parameter. The entered `naicsCode` will not be applied. ")] = None, + location: Annotated[Optional[StrictStr], Field(description="The location member ID. If the ID is not provided, the response returns the benchmark value across all locations. ")] = None, + company_size: Annotated[Optional[StrictStr], Field(description="The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes. ")] = None, + career_level: Annotated[Optional[StrictStr], Field(description="The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BenchmarkValue]: + """Get base salary benchmark value + + Retrieve the base salary benchmark value. + + :param job: The job member ID. (required) + :type job: str + :param industry: The industry member ID. If the ID is not provided, the response returns the benchmark value across all industries. + :type industry: str + :param naics_code: The North American Industry Classification System (NAICS) code. If the NAICS code is not provided, the response returns the benchmark value across all industries. If both `naicsCode` and `industry` are provided, the response returns the benchmark value for the `industry` parameter. The entered `naicsCode` will not be applied. + :type naics_code: str + :param location: The location member ID. If the ID is not provided, the response returns the benchmark value across all locations. + :type location: str + :param company_size: The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes. + :type company_size: str + :param career_level: The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. + :type career_level: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_salary_benchmark_serialize( + job=job, + industry=industry, + naics_code=naics_code, + location=location, + company_size=company_size, + career_level=career_level, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BenchmarkValue", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_salary_benchmark_without_preload_content( + self, + job: Annotated[StrictStr, Field(description="The job member ID. ")], + industry: Annotated[Optional[StrictStr], Field(description="The industry member ID. If the ID is not provided, the response returns the benchmark value across all industries. ")] = None, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If the NAICS code is not provided, the response returns the benchmark value across all industries. If both `naicsCode` and `industry` are provided, the response returns the benchmark value for the `industry` parameter. The entered `naicsCode` will not be applied. ")] = None, + location: Annotated[Optional[StrictStr], Field(description="The location member ID. If the ID is not provided, the response returns the benchmark value across all locations. ")] = None, + company_size: Annotated[Optional[StrictStr], Field(description="The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes. ")] = None, + career_level: Annotated[Optional[StrictStr], Field(description="The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get base salary benchmark value + + Retrieve the base salary benchmark value. + + :param job: The job member ID. (required) + :type job: str + :param industry: The industry member ID. If the ID is not provided, the response returns the benchmark value across all industries. + :type industry: str + :param naics_code: The North American Industry Classification System (NAICS) code. If the NAICS code is not provided, the response returns the benchmark value across all industries. If both `naicsCode` and `industry` are provided, the response returns the benchmark value for the `industry` parameter. The entered `naicsCode` will not be applied. + :type naics_code: str + :param location: The location member ID. If the ID is not provided, the response returns the benchmark value across all locations. + :type location: str + :param company_size: The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes. + :type company_size: str + :param career_level: The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. + :type career_level: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_salary_benchmark_serialize( + job=job, + industry=industry, + naics_code=naics_code, + location=location, + company_size=company_size, + career_level=career_level, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BenchmarkValue", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_salary_benchmark_serialize( + self, + job, + industry, + naics_code, + location, + company_size, + career_level, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if job is not None: + + _query_params.append(('job', job)) + + if industry is not None: + + _query_params.append(('industry', industry)) + + if naics_code is not None: + + _query_params.append(('naicsCode', naics_code)) + + if location is not None: + + _query_params.append(('location', location)) + + if company_size is not None: + + _query_params.append(('companySize', company_size)) + + if career_level is not None: + + _query_params.append(('careerLevel', career_level)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/compensation-benchmarks/base-salary', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_salary_benchmarks_in_bulk( + self, + salary_benchmark_input: Annotated[List[SalaryBenchmarkInput], Field(description="A batch request takes a JSON object consisting of an array of your requests. You can batch up to 1000 individual requests in one API call. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SalaryBenchmarksBatchProcessingOutputs: + """Get salary benchmark values in bulk + + Retrieve multiple base salary benchmark values in a single request. + + :param salary_benchmark_input: A batch request takes a JSON object consisting of an array of your requests. You can batch up to 1000 individual requests in one API call. (required) + :type salary_benchmark_input: List[SalaryBenchmarkInput] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_salary_benchmarks_in_bulk_serialize( + salary_benchmark_input=salary_benchmark_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SalaryBenchmarksBatchProcessingOutputs", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_salary_benchmarks_in_bulk_with_http_info( + self, + salary_benchmark_input: Annotated[List[SalaryBenchmarkInput], Field(description="A batch request takes a JSON object consisting of an array of your requests. You can batch up to 1000 individual requests in one API call. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SalaryBenchmarksBatchProcessingOutputs]: + """Get salary benchmark values in bulk + + Retrieve multiple base salary benchmark values in a single request. + + :param salary_benchmark_input: A batch request takes a JSON object consisting of an array of your requests. You can batch up to 1000 individual requests in one API call. (required) + :type salary_benchmark_input: List[SalaryBenchmarkInput] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_salary_benchmarks_in_bulk_serialize( + salary_benchmark_input=salary_benchmark_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SalaryBenchmarksBatchProcessingOutputs", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_salary_benchmarks_in_bulk_without_preload_content( + self, + salary_benchmark_input: Annotated[List[SalaryBenchmarkInput], Field(description="A batch request takes a JSON object consisting of an array of your requests. You can batch up to 1000 individual requests in one API call. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get salary benchmark values in bulk + + Retrieve multiple base salary benchmark values in a single request. + + :param salary_benchmark_input: A batch request takes a JSON object consisting of an array of your requests. You can batch up to 1000 individual requests in one API call. (required) + :type salary_benchmark_input: List[SalaryBenchmarkInput] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_salary_benchmarks_in_bulk_serialize( + salary_benchmark_input=salary_benchmark_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SalaryBenchmarksBatchProcessingOutputs", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_salary_benchmarks_in_bulk_serialize( + self, + salary_benchmark_input, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'SalaryBenchmarkInput': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if salary_benchmark_input is not None: + _body_params = salary_benchmark_input + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/compensation-benchmarks/base-salaries', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/concepts_v2_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/concepts_v2_api.py new file mode 100644 index 0000000000..5a8bd84332 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/concepts_v2_api.py @@ -0,0 +1,2307 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.servicing_v2_objectconfiguration_bulk_change_response_dto import ServicingV2ObjectconfigurationBulkChangeResponseDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_delete_request_dto import ServicingV2ObjectconfigurationConceptDeleteRequestDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_request_dto import ServicingV2ObjectconfigurationConceptRequestDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_response_dto import ServicingV2ObjectconfigurationConceptResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class ConceptsV2Api: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def create_concepts( + self, + servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingV2ObjectconfigurationBulkChangeResponseDTO: + """Create concepts + + Create new concepts. The response returns whether each concept was successfully created or not. When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_concepts_serialize( + servicing_v2_objectconfiguration_concept_request_dto=servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_concepts_with_http_info( + self, + servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingV2ObjectconfigurationBulkChangeResponseDTO]: + """Create concepts + + Create new concepts. The response returns whether each concept was successfully created or not. When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_concepts_serialize( + servicing_v2_objectconfiguration_concept_request_dto=servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_concepts_without_preload_content( + self, + servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create concepts + + Create new concepts. The response returns whether each concept was successfully created or not. When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_concepts_serialize( + servicing_v2_objectconfiguration_concept_request_dto=servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_concepts_serialize( + self, + servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_v2_objectconfiguration_concept_request_dto is not None: + _body_params = servicing_v2_objectconfiguration_concept_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v2alpha/data/model/concepts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_concepts( + self, + servicing_v2_objectconfiguration_concept_delete_request_dto: ServicingV2ObjectconfigurationConceptDeleteRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingV2ObjectconfigurationBulkChangeResponseDTO: + """Delete concepts + + Delete existing concepts. The response returns whether each concept was successfully deleted or not.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_delete_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_delete_request_dto: ServicingV2ObjectconfigurationConceptDeleteRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_concepts_serialize( + servicing_v2_objectconfiguration_concept_delete_request_dto=servicing_v2_objectconfiguration_concept_delete_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_concepts_with_http_info( + self, + servicing_v2_objectconfiguration_concept_delete_request_dto: ServicingV2ObjectconfigurationConceptDeleteRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingV2ObjectconfigurationBulkChangeResponseDTO]: + """Delete concepts + + Delete existing concepts. The response returns whether each concept was successfully deleted or not.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_delete_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_delete_request_dto: ServicingV2ObjectconfigurationConceptDeleteRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_concepts_serialize( + servicing_v2_objectconfiguration_concept_delete_request_dto=servicing_v2_objectconfiguration_concept_delete_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_concepts_without_preload_content( + self, + servicing_v2_objectconfiguration_concept_delete_request_dto: ServicingV2ObjectconfigurationConceptDeleteRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete concepts + + Delete existing concepts. The response returns whether each concept was successfully deleted or not.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_delete_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_delete_request_dto: ServicingV2ObjectconfigurationConceptDeleteRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_concepts_serialize( + servicing_v2_objectconfiguration_concept_delete_request_dto=servicing_v2_objectconfiguration_concept_delete_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_concepts_serialize( + self, + servicing_v2_objectconfiguration_concept_delete_request_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_v2_objectconfiguration_concept_delete_request_dto is not None: + _body_params = servicing_v2_objectconfiguration_concept_delete_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v2alpha/data/model/concepts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_concepts( + self, + type: Annotated[Optional[List[StrictStr]], Field(description="The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default.")] = None, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`.")] = None, + object_name: Annotated[Optional[List[StrictStr]], Field(description="The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None, + uuid: Annotated[Optional[List[StrictStr]], Field(description="The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingV2ObjectconfigurationConceptResponseDTO: + """Retrieve a list of concepts + + Retrieve a list of all concepts in your Visier tenant.
**Note:** 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). + + :param type: The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default. + :type type: List[str] + :param var_with: The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`. + :type var_with: List[str] + :param object_name: The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`. + :type object_name: List[str] + :param uuid: The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`. + :type uuid: List[str] + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_concepts_serialize( + type=type, + var_with=var_with, + object_name=object_name, + uuid=uuid, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationConceptResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_concepts_with_http_info( + self, + type: Annotated[Optional[List[StrictStr]], Field(description="The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default.")] = None, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`.")] = None, + object_name: Annotated[Optional[List[StrictStr]], Field(description="The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None, + uuid: Annotated[Optional[List[StrictStr]], Field(description="The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingV2ObjectconfigurationConceptResponseDTO]: + """Retrieve a list of concepts + + Retrieve a list of all concepts in your Visier tenant.
**Note:** 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). + + :param type: The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default. + :type type: List[str] + :param var_with: The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`. + :type var_with: List[str] + :param object_name: The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`. + :type object_name: List[str] + :param uuid: The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`. + :type uuid: List[str] + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_concepts_serialize( + type=type, + var_with=var_with, + object_name=object_name, + uuid=uuid, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationConceptResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_concepts_without_preload_content( + self, + type: Annotated[Optional[List[StrictStr]], Field(description="The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default.")] = None, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`.")] = None, + object_name: Annotated[Optional[List[StrictStr]], Field(description="The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None, + uuid: Annotated[Optional[List[StrictStr]], Field(description="The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of concepts + + Retrieve a list of all concepts in your Visier tenant.
**Note:** 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). + + :param type: The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default. + :type type: List[str] + :param var_with: The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`. + :type var_with: List[str] + :param object_name: The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`. + :type object_name: List[str] + :param uuid: The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`. + :type uuid: List[str] + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_concepts_serialize( + type=type, + var_with=var_with, + object_name=object_name, + uuid=uuid, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationConceptResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_concepts_serialize( + self, + type, + var_with, + object_name, + uuid, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'type': 'multi', + 'with': 'multi', + 'objectName': 'multi', + 'uuid': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if type is not None: + + _query_params.append(('type', type)) + + if var_with is not None: + + _query_params.append(('with', var_with)) + + if object_name is not None: + + _query_params.append(('objectName', object_name)) + + if uuid is not None: + + _query_params.append(('uuid', uuid)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v2alpha/data/model/concepts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_analytic_object_concepts( + self, + analytic_object_name: Annotated[StrictStr, Field(description="The object name of the analytic object from which to retrieve concepts.")], + type: Annotated[Optional[List[StrictStr]], Field(description="The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default.")] = None, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`.")] = None, + object_name: Annotated[Optional[List[StrictStr]], Field(description="The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None, + uuid: Annotated[Optional[List[StrictStr]], Field(description="The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingV2ObjectconfigurationConceptResponseDTO: + """Retrieve a list of concepts by analytic object + + Retrieve all the concepts for a specific analytic object. The response returns the details of all concepts for the analytic object, including object names, concept types, and descriptions.
**Note:** 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). + + :param analytic_object_name: The object name of the analytic object from which to retrieve concepts. (required) + :type analytic_object_name: str + :param type: The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default. + :type type: List[str] + :param var_with: The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`. + :type var_with: List[str] + :param object_name: The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`. + :type object_name: List[str] + :param uuid: The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`. + :type uuid: List[str] + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_object_concepts_serialize( + analytic_object_name=analytic_object_name, + type=type, + var_with=var_with, + object_name=object_name, + uuid=uuid, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationConceptResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_analytic_object_concepts_with_http_info( + self, + analytic_object_name: Annotated[StrictStr, Field(description="The object name of the analytic object from which to retrieve concepts.")], + type: Annotated[Optional[List[StrictStr]], Field(description="The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default.")] = None, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`.")] = None, + object_name: Annotated[Optional[List[StrictStr]], Field(description="The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None, + uuid: Annotated[Optional[List[StrictStr]], Field(description="The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingV2ObjectconfigurationConceptResponseDTO]: + """Retrieve a list of concepts by analytic object + + Retrieve all the concepts for a specific analytic object. The response returns the details of all concepts for the analytic object, including object names, concept types, and descriptions.
**Note:** 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). + + :param analytic_object_name: The object name of the analytic object from which to retrieve concepts. (required) + :type analytic_object_name: str + :param type: The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default. + :type type: List[str] + :param var_with: The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`. + :type var_with: List[str] + :param object_name: The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`. + :type object_name: List[str] + :param uuid: The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`. + :type uuid: List[str] + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_object_concepts_serialize( + analytic_object_name=analytic_object_name, + type=type, + var_with=var_with, + object_name=object_name, + uuid=uuid, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationConceptResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_analytic_object_concepts_without_preload_content( + self, + analytic_object_name: Annotated[StrictStr, Field(description="The object name of the analytic object from which to retrieve concepts.")], + type: Annotated[Optional[List[StrictStr]], Field(description="The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default.")] = None, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`.")] = None, + object_name: Annotated[Optional[List[StrictStr]], Field(description="The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.")] = None, + uuid: Annotated[Optional[List[StrictStr]], Field(description="The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of concepts by analytic object + + Retrieve all the concepts for a specific analytic object. The response returns the details of all concepts for the analytic object, including object names, concept types, and descriptions.
**Note:** 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). + + :param analytic_object_name: The object name of the analytic object from which to retrieve concepts. (required) + :type analytic_object_name: str + :param type: The type of the concept to retrieve. Valid values: - `process`: Retrieves all process concepts. This is the default. + :type type: List[str] + :param var_with: The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`. + :type var_with: List[str] + :param object_name: The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`. + :type object_name: List[str] + :param uuid: The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`. + :type uuid: List[str] + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_object_concepts_serialize( + analytic_object_name=analytic_object_name, + type=type, + var_with=var_with, + object_name=object_name, + uuid=uuid, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationConceptResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_analytic_object_concepts_serialize( + self, + analytic_object_name, + type, + var_with, + object_name, + uuid, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'type': 'multi', + 'with': 'multi', + 'objectName': 'multi', + 'uuid': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if analytic_object_name is not None: + _path_params['analyticObjectName'] = analytic_object_name + # process the query parameters + if type is not None: + + _query_params.append(('type', type)) + + if var_with is not None: + + _query_params.append(('with', var_with)) + + if object_name is not None: + + _query_params.append(('objectName', object_name)) + + if uuid is not None: + + _query_params.append(('uuid', uuid)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v2alpha/data/model/analytic-objects/{analyticObjectName}/concepts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_one_concept( + self, + concept_id: Annotated[StrictStr, Field(description="The object name or UUID of the concept to retrieve.")], + var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingV2ObjectconfigurationConceptResponseDTO: + """Retrieve a concept's details + + Retrieve the details of a specific concept, such as its concept type and description.
**Note:** 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). + + :param concept_id: The object name or UUID of the concept to retrieve. (required) + :type concept_id: str + :param var_with: The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`. + :type var_with: List[str] + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_one_concept_serialize( + concept_id=concept_id, + var_with=var_with, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationConceptResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_one_concept_with_http_info( + self, + concept_id: Annotated[StrictStr, Field(description="The object name or UUID of the concept to retrieve.")], + var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingV2ObjectconfigurationConceptResponseDTO]: + """Retrieve a concept's details + + Retrieve the details of a specific concept, such as its concept type and description.
**Note:** 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). + + :param concept_id: The object name or UUID of the concept to retrieve. (required) + :type concept_id: str + :param var_with: The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`. + :type var_with: List[str] + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_one_concept_serialize( + concept_id=concept_id, + var_with=var_with, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationConceptResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_one_concept_without_preload_content( + self, + concept_id: Annotated[StrictStr, Field(description="The object name or UUID of the concept to retrieve.")], + var_with: Annotated[Optional[List[StrictStr]], Field(description="The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a concept's details + + Retrieve the details of a specific concept, such as its concept type and description.
**Note:** 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). + + :param concept_id: The object name or UUID of the concept to retrieve. (required) + :type concept_id: str + :param var_with: The level of information to retrieve for the concept. Valid values: - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default. - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInApp`. + :type var_with: List[str] + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_one_concept_serialize( + concept_id=concept_id, + var_with=var_with, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationConceptResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_one_concept_serialize( + self, + concept_id, + var_with, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'with': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if concept_id is not None: + _path_params['conceptId'] = concept_id + # process the query parameters + if var_with is not None: + + _query_params.append(('with', var_with)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v2alpha/data/model/concepts/{conceptId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def patch_concepts( + self, + servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingV2ObjectconfigurationBulkChangeResponseDTO: + """Partially update concepts + + Make partial changes to existing concepts. The response returns whether each concept was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition. Unlike `PUT`, which completely replaces the concept definition, use `PATCH` to change specific fields in the concept without affecting omitted fields. To replace a concept's entire definition, see the `PUT` method.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_concepts_serialize( + servicing_v2_objectconfiguration_concept_request_dto=servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_concepts_with_http_info( + self, + servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingV2ObjectconfigurationBulkChangeResponseDTO]: + """Partially update concepts + + Make partial changes to existing concepts. The response returns whether each concept was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition. Unlike `PUT`, which completely replaces the concept definition, use `PATCH` to change specific fields in the concept without affecting omitted fields. To replace a concept's entire definition, see the `PUT` method.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_concepts_serialize( + servicing_v2_objectconfiguration_concept_request_dto=servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_concepts_without_preload_content( + self, + servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Partially update concepts + + Make partial changes to existing concepts. The response returns whether each concept was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition. Unlike `PUT`, which completely replaces the concept definition, use `PATCH` to change specific fields in the concept without affecting omitted fields. To replace a concept's entire definition, see the `PUT` method.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_concepts_serialize( + servicing_v2_objectconfiguration_concept_request_dto=servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_concepts_serialize( + self, + servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_v2_objectconfiguration_concept_request_dto is not None: + _body_params = servicing_v2_objectconfiguration_concept_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/v2alpha/data/model/concepts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def put_concepts( + self, + servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingV2ObjectconfigurationBulkChangeResponseDTO: + """Update concepts + + Update existing concepts. The response returns whether each concept was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition. In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the concept. To partially update a concept, see the `PATCH` method.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_concepts_serialize( + servicing_v2_objectconfiguration_concept_request_dto=servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_concepts_with_http_info( + self, + servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingV2ObjectconfigurationBulkChangeResponseDTO]: + """Update concepts + + Update existing concepts. The response returns whether each concept was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition. In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the concept. To partially update a concept, see the `PATCH` method.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_concepts_serialize( + servicing_v2_objectconfiguration_concept_request_dto=servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_concepts_without_preload_content( + self, + servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update concepts + + Update existing concepts. The response returns whether each concept was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition. In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the concept. To partially update a concept, see the `PATCH` method.
**Note:** 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). + + :param servicing_v2_objectconfiguration_concept_request_dto: (required) + :type servicing_v2_objectconfiguration_concept_request_dto: ServicingV2ObjectconfigurationConceptRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_concepts_serialize( + servicing_v2_objectconfiguration_concept_request_dto=servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_concepts_serialize( + self, + servicing_v2_objectconfiguration_concept_request_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_v2_objectconfiguration_concept_request_dto is not None: + _body_params = servicing_v2_objectconfiguration_concept_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v2alpha/data/model/concepts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/consolidated_analytics_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/consolidated_analytics_api.py new file mode 100644 index 0000000000..885d751ed1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/consolidated_analytics_api.py @@ -0,0 +1,3265 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_consolidated_analytics_api_excluded_source_list_dto import AdminConsolidatedAnalyticsAPIExcludedSourceListDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_source_tenant_list_dto import AdminConsolidatedAnalyticsAPISourceTenantListDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_create_request_dto import AdminConsolidatedAnalyticsAPITenantCreateRequestDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_list_response_dto import AdminConsolidatedAnalyticsAPITenantListResponseDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_with_details_list_response_dto import AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO +from visier_platform_sdk.models.admin_excluded_sources_body import AdminExcludedSourcesBody +from visier_platform_sdk.models.admin_tenant_code_body import AdminTenantCodeBody + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class ConsolidatedAnalyticsApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def add_excluded_sources( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_excluded_sources_body: AdminExcludedSourcesBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPIExcludedSourceListDTO: + """Add excluded sources to a consolidated analytics tenant + + Add excluded sources to the list of excluded sources for a consolidated analytics tenant.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_excluded_sources_body: (required) + :type admin_excluded_sources_body: AdminExcludedSourcesBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_excluded_sources_serialize( + tenant_id=tenant_id, + admin_excluded_sources_body=admin_excluded_sources_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def add_excluded_sources_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_excluded_sources_body: AdminExcludedSourcesBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPIExcludedSourceListDTO]: + """Add excluded sources to a consolidated analytics tenant + + Add excluded sources to the list of excluded sources for a consolidated analytics tenant.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_excluded_sources_body: (required) + :type admin_excluded_sources_body: AdminExcludedSourcesBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_excluded_sources_serialize( + tenant_id=tenant_id, + admin_excluded_sources_body=admin_excluded_sources_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def add_excluded_sources_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_excluded_sources_body: AdminExcludedSourcesBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add excluded sources to a consolidated analytics tenant + + Add excluded sources to the list of excluded sources for a consolidated analytics tenant.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_excluded_sources_body: (required) + :type admin_excluded_sources_body: AdminExcludedSourcesBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_excluded_sources_serialize( + tenant_id=tenant_id, + admin_excluded_sources_body=admin_excluded_sources_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _add_excluded_sources_serialize( + self, + tenant_id, + admin_excluded_sources_body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if admin_excluded_sources_body is not None: + _body_params = admin_excluded_sources_body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/v1alpha/admin/consolidated-analytics/tenants/{tenantId}/excluded-sources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def add_source_tenants( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_tenant_code_body: AdminTenantCodeBody, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPISourceTenantListDTO: + """Add source tenants to a consolidated analytics tenant + + Add source tenants to the list of source tenants for a consolidated analytics tenant. If successful, the response returns an updated list of source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_tenant_code_body: (required) + :type admin_tenant_code_body: AdminTenantCodeBody + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_source_tenants_serialize( + tenant_id=tenant_id, + admin_tenant_code_body=admin_tenant_code_body, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def add_source_tenants_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_tenant_code_body: AdminTenantCodeBody, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPISourceTenantListDTO]: + """Add source tenants to a consolidated analytics tenant + + Add source tenants to the list of source tenants for a consolidated analytics tenant. If successful, the response returns an updated list of source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_tenant_code_body: (required) + :type admin_tenant_code_body: AdminTenantCodeBody + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_source_tenants_serialize( + tenant_id=tenant_id, + admin_tenant_code_body=admin_tenant_code_body, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def add_source_tenants_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_tenant_code_body: AdminTenantCodeBody, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add source tenants to a consolidated analytics tenant + + Add source tenants to the list of source tenants for a consolidated analytics tenant. If successful, the response returns an updated list of source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_tenant_code_body: (required) + :type admin_tenant_code_body: AdminTenantCodeBody + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_source_tenants_serialize( + tenant_id=tenant_id, + admin_tenant_code_body=admin_tenant_code_body, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _add_source_tenants_serialize( + self, + tenant_id, + admin_tenant_code_body, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + if admin_tenant_code_body is not None: + _body_params = admin_tenant_code_body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/v1alpha/admin/consolidated-analytics/tenants/{tenantId}/source-tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_tenant( + self, + admin_consolidated_analytics_api_tenant_create_request_dto: AdminConsolidatedAnalyticsAPITenantCreateRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPITenantCreateRequestDTO: + """Create a consolidated analytics tenant + + Create a consolidated analytics tenant. A new CA tenant has no source tenants and no excluded sources. **Note:** CA tenant codes must have a prefix of CA. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
**Note:** 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). + + :param admin_consolidated_analytics_api_tenant_create_request_dto: (required) + :type admin_consolidated_analytics_api_tenant_create_request_dto: AdminConsolidatedAnalyticsAPITenantCreateRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tenant_serialize( + admin_consolidated_analytics_api_tenant_create_request_dto=admin_consolidated_analytics_api_tenant_create_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPITenantCreateRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_tenant_with_http_info( + self, + admin_consolidated_analytics_api_tenant_create_request_dto: AdminConsolidatedAnalyticsAPITenantCreateRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPITenantCreateRequestDTO]: + """Create a consolidated analytics tenant + + Create a consolidated analytics tenant. A new CA tenant has no source tenants and no excluded sources. **Note:** CA tenant codes must have a prefix of CA. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
**Note:** 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). + + :param admin_consolidated_analytics_api_tenant_create_request_dto: (required) + :type admin_consolidated_analytics_api_tenant_create_request_dto: AdminConsolidatedAnalyticsAPITenantCreateRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tenant_serialize( + admin_consolidated_analytics_api_tenant_create_request_dto=admin_consolidated_analytics_api_tenant_create_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPITenantCreateRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_tenant_without_preload_content( + self, + admin_consolidated_analytics_api_tenant_create_request_dto: AdminConsolidatedAnalyticsAPITenantCreateRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a consolidated analytics tenant + + Create a consolidated analytics tenant. A new CA tenant has no source tenants and no excluded sources. **Note:** CA tenant codes must have a prefix of CA. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
**Note:** 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). + + :param admin_consolidated_analytics_api_tenant_create_request_dto: (required) + :type admin_consolidated_analytics_api_tenant_create_request_dto: AdminConsolidatedAnalyticsAPITenantCreateRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tenant_serialize( + admin_consolidated_analytics_api_tenant_create_request_dto=admin_consolidated_analytics_api_tenant_create_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPITenantCreateRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_tenant_serialize( + self, + admin_consolidated_analytics_api_tenant_create_request_dto, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if admin_consolidated_analytics_api_tenant_create_request_dto is not None: + _body_params = admin_consolidated_analytics_api_tenant_create_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/admin/consolidated-analytics/tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_excluded_sources( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPIExcludedSourceListDTO: + """Retrieve a consolidated analytics tenant's excluded sources + + Retrieve a CA tenant's excluded sources.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_excluded_sources_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_excluded_sources_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPIExcludedSourceListDTO]: + """Retrieve a consolidated analytics tenant's excluded sources + + Retrieve a CA tenant's excluded sources.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_excluded_sources_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_excluded_sources_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a consolidated analytics tenant's excluded sources + + Retrieve a CA tenant's excluded sources.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_excluded_sources_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_excluded_sources_serialize( + self, + tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/admin/consolidated-analytics/tenants/{tenantId}/excluded-sources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_source_tenants( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first source tenant to return. Default is 0.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPISourceTenantListDTO: + """Retrieve a consolidated analytics tenant's source tenants + + Retrieve a CA tenant's source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param start: The starting index of the first source tenant to return. Default is 0. + :type start: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_source_tenants_serialize( + tenant_id=tenant_id, + limit=limit, + start=start, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_source_tenants_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first source tenant to return. Default is 0.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPISourceTenantListDTO]: + """Retrieve a consolidated analytics tenant's source tenants + + Retrieve a CA tenant's source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param start: The starting index of the first source tenant to return. Default is 0. + :type start: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_source_tenants_serialize( + tenant_id=tenant_id, + limit=limit, + start=start, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_source_tenants_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first source tenant to return. Default is 0.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a consolidated analytics tenant's source tenants + + Retrieve a CA tenant's source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param start: The starting index of the first source tenant to return. Default is 0. + :type start: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_source_tenants_serialize( + tenant_id=tenant_id, + limit=limit, + start=start, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_source_tenants_serialize( + self, + tenant_id, + limit, + start, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/admin/consolidated-analytics/tenants/{tenantId}/source-tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_tenants( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of tenants to return. The maximum value is 1000. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first tenant to return. Default is 0.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPITenantListResponseDTO: + """Retrieve a list of all consolidated analytics tenants + + Retrieve the full list of consolidated analytics tenants in your administrating tenant.
**Note:** 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). + + :param limit: The maximum number of tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param start: The starting index of the first tenant to return. Default is 0. + :type start: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_tenants_serialize( + limit=limit, + start=start, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPITenantListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_tenants_with_http_info( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of tenants to return. The maximum value is 1000. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first tenant to return. Default is 0.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPITenantListResponseDTO]: + """Retrieve a list of all consolidated analytics tenants + + Retrieve the full list of consolidated analytics tenants in your administrating tenant.
**Note:** 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). + + :param limit: The maximum number of tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param start: The starting index of the first tenant to return. Default is 0. + :type start: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_tenants_serialize( + limit=limit, + start=start, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPITenantListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_tenants_without_preload_content( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of tenants to return. The maximum value is 1000. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first tenant to return. Default is 0.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all consolidated analytics tenants + + Retrieve the full list of consolidated analytics tenants in your administrating tenant.
**Note:** 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). + + :param limit: The maximum number of tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param start: The starting index of the first tenant to return. Default is 0. + :type start: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_tenants_serialize( + limit=limit, + start=start, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPITenantListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_tenants_serialize( + self, + limit, + start, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/admin/consolidated-analytics/tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_tenants_with_details( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of tenants to return. The maximum value is 1000. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first tenant to return. Default is 0.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO: + """Retrieve the details of all consolidated analytics tenants + + Retrieve the full list of consolidated analytics tenants and their details in your administrating tenant. **Note:** If your consolidated analytics tenants have thousands of source tenants, we recommend that you use the `GET /admin/consolidated-analytics/tenants` endpoint to get all CA tenants and then use the `GET /admin/consolidated-analytics/tenants/{tenantId}/source-tenants` and `GET /admin/consolidated-analytics/tenants/{tenantId}/excluded-sources` endpoints to retrieve information about specific CA tenants.
**Note:** 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). + + :param limit: The maximum number of tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param start: The starting index of the first tenant to return. Default is 0. + :type start: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_tenants_with_details_serialize( + limit=limit, + start=start, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_tenants_with_details_with_http_info( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of tenants to return. The maximum value is 1000. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first tenant to return. Default is 0.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO]: + """Retrieve the details of all consolidated analytics tenants + + Retrieve the full list of consolidated analytics tenants and their details in your administrating tenant. **Note:** If your consolidated analytics tenants have thousands of source tenants, we recommend that you use the `GET /admin/consolidated-analytics/tenants` endpoint to get all CA tenants and then use the `GET /admin/consolidated-analytics/tenants/{tenantId}/source-tenants` and `GET /admin/consolidated-analytics/tenants/{tenantId}/excluded-sources` endpoints to retrieve information about specific CA tenants.
**Note:** 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). + + :param limit: The maximum number of tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param start: The starting index of the first tenant to return. Default is 0. + :type start: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_tenants_with_details_serialize( + limit=limit, + start=start, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_tenants_with_details_without_preload_content( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of tenants to return. The maximum value is 1000. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first tenant to return. Default is 0.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the details of all consolidated analytics tenants + + Retrieve the full list of consolidated analytics tenants and their details in your administrating tenant. **Note:** If your consolidated analytics tenants have thousands of source tenants, we recommend that you use the `GET /admin/consolidated-analytics/tenants` endpoint to get all CA tenants and then use the `GET /admin/consolidated-analytics/tenants/{tenantId}/source-tenants` and `GET /admin/consolidated-analytics/tenants/{tenantId}/excluded-sources` endpoints to retrieve information about specific CA tenants.
**Note:** 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). + + :param limit: The maximum number of tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param start: The starting index of the first tenant to return. Default is 0. + :type start: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_tenants_with_details_serialize( + limit=limit, + start=start, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_tenants_with_details_serialize( + self, + limit, + start, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/admin/consolidated-analytics/tenants-with-details', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def remove_excluded_sources( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_excluded_sources_body: AdminExcludedSourcesBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPIExcludedSourceListDTO: + """Remove excluded sources from a consolidated analytics tenants + + Remove excluded sources from the list of excluded sources for a consolidated analytics tenant.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_excluded_sources_body: (required) + :type admin_excluded_sources_body: AdminExcludedSourcesBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_excluded_sources_serialize( + tenant_id=tenant_id, + admin_excluded_sources_body=admin_excluded_sources_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def remove_excluded_sources_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_excluded_sources_body: AdminExcludedSourcesBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPIExcludedSourceListDTO]: + """Remove excluded sources from a consolidated analytics tenants + + Remove excluded sources from the list of excluded sources for a consolidated analytics tenant.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_excluded_sources_body: (required) + :type admin_excluded_sources_body: AdminExcludedSourcesBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_excluded_sources_serialize( + tenant_id=tenant_id, + admin_excluded_sources_body=admin_excluded_sources_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def remove_excluded_sources_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_excluded_sources_body: AdminExcludedSourcesBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Remove excluded sources from a consolidated analytics tenants + + Remove excluded sources from the list of excluded sources for a consolidated analytics tenant.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_excluded_sources_body: (required) + :type admin_excluded_sources_body: AdminExcludedSourcesBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_excluded_sources_serialize( + tenant_id=tenant_id, + admin_excluded_sources_body=admin_excluded_sources_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _remove_excluded_sources_serialize( + self, + tenant_id, + admin_excluded_sources_body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if admin_excluded_sources_body is not None: + _body_params = admin_excluded_sources_body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1alpha/admin/consolidated-analytics/tenants/{tenantId}/excluded-sources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def remove_source_tenants( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_tenant_code_body: AdminTenantCodeBody, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPISourceTenantListDTO: + """Remove source tenants from a consolidated analytics tenants + + Remove source tenants from the list of source tenants for a consolidated analytics tenant. If successful, the response returns an updated list of source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_tenant_code_body: (required) + :type admin_tenant_code_body: AdminTenantCodeBody + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_source_tenants_serialize( + tenant_id=tenant_id, + admin_tenant_code_body=admin_tenant_code_body, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def remove_source_tenants_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_tenant_code_body: AdminTenantCodeBody, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPISourceTenantListDTO]: + """Remove source tenants from a consolidated analytics tenants + + Remove source tenants from the list of source tenants for a consolidated analytics tenant. If successful, the response returns an updated list of source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_tenant_code_body: (required) + :type admin_tenant_code_body: AdminTenantCodeBody + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_source_tenants_serialize( + tenant_id=tenant_id, + admin_tenant_code_body=admin_tenant_code_body, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def remove_source_tenants_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_tenant_code_body: AdminTenantCodeBody, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Remove source tenants from a consolidated analytics tenants + + Remove source tenants from the list of source tenants for a consolidated analytics tenant. If successful, the response returns an updated list of source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_tenant_code_body: (required) + :type admin_tenant_code_body: AdminTenantCodeBody + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_source_tenants_serialize( + tenant_id=tenant_id, + admin_tenant_code_body=admin_tenant_code_body, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _remove_source_tenants_serialize( + self, + tenant_id, + admin_tenant_code_body, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + if admin_tenant_code_body is not None: + _body_params = admin_tenant_code_body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1alpha/admin/consolidated-analytics/tenants/{tenantId}/source-tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def set_excluded_sources( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_excluded_sources_body: AdminExcludedSourcesBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPIExcludedSourceListDTO: + """Set a consolidated analytics tenant's excluded sources + + Define the excluded sources for a consolidated analytics tenant. After you create a CA tenant, you may optionally define a list of excluded sources. The excluded sources are the sources whose data is excluded from the CA tenant. You can also use this API to replace the list of excluded sources for an existing CA tenant.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_excluded_sources_body: (required) + :type admin_excluded_sources_body: AdminExcludedSourcesBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_excluded_sources_serialize( + tenant_id=tenant_id, + admin_excluded_sources_body=admin_excluded_sources_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_excluded_sources_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_excluded_sources_body: AdminExcludedSourcesBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPIExcludedSourceListDTO]: + """Set a consolidated analytics tenant's excluded sources + + Define the excluded sources for a consolidated analytics tenant. After you create a CA tenant, you may optionally define a list of excluded sources. The excluded sources are the sources whose data is excluded from the CA tenant. You can also use this API to replace the list of excluded sources for an existing CA tenant.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_excluded_sources_body: (required) + :type admin_excluded_sources_body: AdminExcludedSourcesBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_excluded_sources_serialize( + tenant_id=tenant_id, + admin_excluded_sources_body=admin_excluded_sources_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_excluded_sources_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_excluded_sources_body: AdminExcludedSourcesBody, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set a consolidated analytics tenant's excluded sources + + Define the excluded sources for a consolidated analytics tenant. After you create a CA tenant, you may optionally define a list of excluded sources. The excluded sources are the sources whose data is excluded from the CA tenant. You can also use this API to replace the list of excluded sources for an existing CA tenant.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_excluded_sources_body: (required) + :type admin_excluded_sources_body: AdminExcludedSourcesBody + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_excluded_sources_serialize( + tenant_id=tenant_id, + admin_excluded_sources_body=admin_excluded_sources_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPIExcludedSourceListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_excluded_sources_serialize( + self, + tenant_id, + admin_excluded_sources_body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if admin_excluded_sources_body is not None: + _body_params = admin_excluded_sources_body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1alpha/admin/consolidated-analytics/tenants/{tenantId}/excluded-sources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def set_source_tenants( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_tenant_code_body: AdminTenantCodeBody, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminConsolidatedAnalyticsAPISourceTenantListDTO: + """Set a consolidated analytics tenant's source tenants + + Define the source tenants for a consolidated analytics tenant. After you create a CA tenant, you must define a list of its source tenants. The source tenants are the tenants whose data is aggregated in the CA tenant. You can also use this API to replace the list of source tenants for an existing CA tenant. If successful, the response returns an updated list of source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_tenant_code_body: (required) + :type admin_tenant_code_body: AdminTenantCodeBody + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_source_tenants_serialize( + tenant_id=tenant_id, + admin_tenant_code_body=admin_tenant_code_body, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_source_tenants_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_tenant_code_body: AdminTenantCodeBody, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminConsolidatedAnalyticsAPISourceTenantListDTO]: + """Set a consolidated analytics tenant's source tenants + + Define the source tenants for a consolidated analytics tenant. After you create a CA tenant, you must define a list of its source tenants. The source tenants are the tenants whose data is aggregated in the CA tenant. You can also use this API to replace the list of source tenants for an existing CA tenant. If successful, the response returns an updated list of source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_tenant_code_body: (required) + :type admin_tenant_code_body: AdminTenantCodeBody + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_source_tenants_serialize( + tenant_id=tenant_id, + admin_tenant_code_body=admin_tenant_code_body, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_source_tenants_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.")], + admin_tenant_code_body: AdminTenantCodeBody, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of source tenants to return. The maximum value is 1000. Default is 400.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Set a consolidated analytics tenant's source tenants + + Define the source tenants for a consolidated analytics tenant. After you create a CA tenant, you must define a list of its source tenants. The source tenants are the tenants whose data is aggregated in the CA tenant. You can also use this API to replace the list of source tenants for an existing CA tenant. If successful, the response returns an updated list of source tenants.
**Note:** 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). + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code. (required) + :type tenant_id: str + :param admin_tenant_code_body: (required) + :type admin_tenant_code_body: AdminTenantCodeBody + :param limit: The maximum number of source tenants to return. The maximum value is 1000. Default is 400. + :type limit: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_source_tenants_serialize( + tenant_id=tenant_id, + admin_tenant_code_body=admin_tenant_code_body, + limit=limit, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminConsolidatedAnalyticsAPISourceTenantListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_source_tenants_serialize( + self, + tenant_id, + admin_tenant_code_body, + limit, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + # process the form parameters + # process the body parameter + if admin_tenant_code_body is not None: + _body_params = admin_tenant_code_body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1alpha/admin/consolidated-analytics/tenants/{tenantId}/source-tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/data_and_job_handling_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/data_and_job_handling_api.py new file mode 100644 index 0000000000..b7064e30da --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/data_and_job_handling_api.py @@ -0,0 +1,8346 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_assign_connector_credentials_response_dto import AdminAssignConnectorCredentialsResponseDTO +from visier_platform_sdk.models.admin_data_import_definitions_apidto import AdminDataImportDefinitionsAPIDTO +from visier_platform_sdk.models.admin_extractor_settings_apidto import AdminExtractorSettingsAPIDTO +from visier_platform_sdk.models.admin_jobs_consolidated_analytics_job_request_dto import AdminJobsConsolidatedAnalyticsJobRequestDTO +from visier_platform_sdk.models.admin_jobs_extract_data_and_load_dto import AdminJobsExtractDataAndLoadDTO +from visier_platform_sdk.models.admin_jobs_processing_job_request_dto import AdminJobsProcessingJobRequestDTO +from visier_platform_sdk.models.admin_multiple_tenant_data_versions_list_dto import AdminMultipleTenantDataVersionsListDTO +from visier_platform_sdk.models.admin_set_connector_settings_request_dto import AdminSetConnectorSettingsRequestDTO +from visier_platform_sdk.models.admin_set_connector_settings_response_dto import AdminSetConnectorSettingsResponseDTO +from visier_platform_sdk.models.data_in_assign_connector_credential_request import DataInAssignConnectorCredentialRequest +from visier_platform_sdk.models.data_in_data_load_request import DataInDataLoadRequest +from visier_platform_sdk.models.data_in_data_load_response import DataInDataLoadResponse +from visier_platform_sdk.models.data_in_disable_dv_request import DataInDisableDVRequest +from visier_platform_sdk.models.data_in_disable_dv_response import DataInDisableDVResponse +from visier_platform_sdk.models.data_in_dispatching_job_status_response import DataInDispatchingJobStatusResponse +from visier_platform_sdk.models.data_in_exclude_data_uploads_request import DataInExcludeDataUploadsRequest +from visier_platform_sdk.models.data_in_extraction_job_and_status_response import DataInExtractionJobAndStatusResponse +from visier_platform_sdk.models.data_in_include_data_uploads_request import DataInIncludeDataUploadsRequest +from visier_platform_sdk.models.data_in_job_status_list_response import DataInJobStatusListResponse +from visier_platform_sdk.models.data_in_processing_job_and_status_response import DataInProcessingJobAndStatusResponse +from visier_platform_sdk.models.data_in_processing_job_status_response import DataInProcessingJobStatusResponse +from visier_platform_sdk.models.data_in_receiving_job_and_status_response import DataInReceivingJobAndStatusResponse +from visier_platform_sdk.models.data_in_receiving_job_status_response import DataInReceivingJobStatusResponse +from visier_platform_sdk.models.data_in_start_extraction_response import DataInStartExtractionResponse +from visier_platform_sdk.models.designer_credential_creation_api_response_dto import DesignerCredentialCreationAPIResponseDTO +from visier_platform_sdk.models.designer_data_provider_auth_information_dto import DesignerDataProviderAuthInformationDTO +from visier_platform_sdk.models.designer_extractor_credentials_apidto import DesignerExtractorCredentialsAPIDTO +from visier_platform_sdk.models.dp_cancel_job_batch_from_job_id_dto import DpCancelJobBatchFromJobIdDTO +from visier_platform_sdk.models.dp_job_cancellation_results_dto import DpJobCancellationResultsDTO +from visier_platform_sdk.models.servicing_data_categories_response_dto import ServicingDataCategoriesResponseDTO +from visier_platform_sdk.models.servicing_job_id_response import ServicingJobIdResponse +from visier_platform_sdk.models.servicing_tenant_data_uploads_list_response_dto import ServicingTenantDataUploadsListResponseDTO +from visier_platform_sdk.models.servicing_tenant_data_uploads_update_response_dto import ServicingTenantDataUploadsUpdateResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class DataAndJobHandlingApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def adhoc_consolidated_analytics_job( + self, + admin_jobs_consolidated_analytics_job_request_dto: AdminJobsConsolidatedAnalyticsJobRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingJobIdResponse: + """Run a consolidated analytics job + + Run a job for a consolidated analytics tenant. This request retrieves data for all source tenants in a consolidated analytics tenant. After the job completes, you can run a processing job to generate a data version for the consolidated analytics tenant. To run a processing job, see `POST /v1alpha/op/jobs/processing-jobs`. + + :param admin_jobs_consolidated_analytics_job_request_dto: (required) + :type admin_jobs_consolidated_analytics_job_request_dto: AdminJobsConsolidatedAnalyticsJobRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._adhoc_consolidated_analytics_job_serialize( + admin_jobs_consolidated_analytics_job_request_dto=admin_jobs_consolidated_analytics_job_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingJobIdResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def adhoc_consolidated_analytics_job_with_http_info( + self, + admin_jobs_consolidated_analytics_job_request_dto: AdminJobsConsolidatedAnalyticsJobRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingJobIdResponse]: + """Run a consolidated analytics job + + Run a job for a consolidated analytics tenant. This request retrieves data for all source tenants in a consolidated analytics tenant. After the job completes, you can run a processing job to generate a data version for the consolidated analytics tenant. To run a processing job, see `POST /v1alpha/op/jobs/processing-jobs`. + + :param admin_jobs_consolidated_analytics_job_request_dto: (required) + :type admin_jobs_consolidated_analytics_job_request_dto: AdminJobsConsolidatedAnalyticsJobRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._adhoc_consolidated_analytics_job_serialize( + admin_jobs_consolidated_analytics_job_request_dto=admin_jobs_consolidated_analytics_job_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingJobIdResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def adhoc_consolidated_analytics_job_without_preload_content( + self, + admin_jobs_consolidated_analytics_job_request_dto: AdminJobsConsolidatedAnalyticsJobRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Run a consolidated analytics job + + Run a job for a consolidated analytics tenant. This request retrieves data for all source tenants in a consolidated analytics tenant. After the job completes, you can run a processing job to generate a data version for the consolidated analytics tenant. To run a processing job, see `POST /v1alpha/op/jobs/processing-jobs`. + + :param admin_jobs_consolidated_analytics_job_request_dto: (required) + :type admin_jobs_consolidated_analytics_job_request_dto: AdminJobsConsolidatedAnalyticsJobRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._adhoc_consolidated_analytics_job_serialize( + admin_jobs_consolidated_analytics_job_request_dto=admin_jobs_consolidated_analytics_job_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingJobIdResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _adhoc_consolidated_analytics_job_serialize( + self, + admin_jobs_consolidated_analytics_job_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_jobs_consolidated_analytics_job_request_dto is not None: + _body_params = admin_jobs_consolidated_analytics_job_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/op/jobs/consolidated-analytics-jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def adhoc_extraction_job( + self, + admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingJobIdResponse: + """Run a data connector extraction job + + Run an extraction job to retrieve data through a Visier data connector and generate a new data version. Administrating tenants can run extraction jobs for all analytic tenants, a list of analytic tenants, or the administrating tenant. If running extraction jobs for an administrating tenant or their analytic tenants, this request starts a dispatching job that generates one extraction job per tenant. The response returns the job ID of the extraction job or dispatching job. + + :param admin_jobs_extract_data_and_load_dto: (required) + :type admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._adhoc_extraction_job_serialize( + admin_jobs_extract_data_and_load_dto=admin_jobs_extract_data_and_load_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingJobIdResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def adhoc_extraction_job_with_http_info( + self, + admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingJobIdResponse]: + """Run a data connector extraction job + + Run an extraction job to retrieve data through a Visier data connector and generate a new data version. Administrating tenants can run extraction jobs for all analytic tenants, a list of analytic tenants, or the administrating tenant. If running extraction jobs for an administrating tenant or their analytic tenants, this request starts a dispatching job that generates one extraction job per tenant. The response returns the job ID of the extraction job or dispatching job. + + :param admin_jobs_extract_data_and_load_dto: (required) + :type admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._adhoc_extraction_job_serialize( + admin_jobs_extract_data_and_load_dto=admin_jobs_extract_data_and_load_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingJobIdResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def adhoc_extraction_job_without_preload_content( + self, + admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Run a data connector extraction job + + Run an extraction job to retrieve data through a Visier data connector and generate a new data version. Administrating tenants can run extraction jobs for all analytic tenants, a list of analytic tenants, or the administrating tenant. If running extraction jobs for an administrating tenant or their analytic tenants, this request starts a dispatching job that generates one extraction job per tenant. The response returns the job ID of the extraction job or dispatching job. + + :param admin_jobs_extract_data_and_load_dto: (required) + :type admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._adhoc_extraction_job_serialize( + admin_jobs_extract_data_and_load_dto=admin_jobs_extract_data_and_load_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingJobIdResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _adhoc_extraction_job_serialize( + self, + admin_jobs_extract_data_and_load_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_jobs_extract_data_and_load_dto is not None: + _body_params = admin_jobs_extract_data_and_load_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/op/jobs/extraction-jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def adhoc_processing_jobs( + self, + admin_jobs_processing_job_request_dto: AdminJobsProcessingJobRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingJobIdResponse: + """Run a processing job + + Run a processing job to generate a new data version. Administrating tenants can run processing jobs for all analytic tenants, a list of analytic tenants, or the administrating tenant. If running processing jobs for an administrating tenant or their analytic tenants, this request starts a dispatching job that generates one processing job per tenant. The response returns the job ID of the processing job or dispatching job. + + :param admin_jobs_processing_job_request_dto: (required) + :type admin_jobs_processing_job_request_dto: AdminJobsProcessingJobRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._adhoc_processing_jobs_serialize( + admin_jobs_processing_job_request_dto=admin_jobs_processing_job_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingJobIdResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def adhoc_processing_jobs_with_http_info( + self, + admin_jobs_processing_job_request_dto: AdminJobsProcessingJobRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingJobIdResponse]: + """Run a processing job + + Run a processing job to generate a new data version. Administrating tenants can run processing jobs for all analytic tenants, a list of analytic tenants, or the administrating tenant. If running processing jobs for an administrating tenant or their analytic tenants, this request starts a dispatching job that generates one processing job per tenant. The response returns the job ID of the processing job or dispatching job. + + :param admin_jobs_processing_job_request_dto: (required) + :type admin_jobs_processing_job_request_dto: AdminJobsProcessingJobRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._adhoc_processing_jobs_serialize( + admin_jobs_processing_job_request_dto=admin_jobs_processing_job_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingJobIdResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def adhoc_processing_jobs_without_preload_content( + self, + admin_jobs_processing_job_request_dto: AdminJobsProcessingJobRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Run a processing job + + Run a processing job to generate a new data version. Administrating tenants can run processing jobs for all analytic tenants, a list of analytic tenants, or the administrating tenant. If running processing jobs for an administrating tenant or their analytic tenants, this request starts a dispatching job that generates one processing job per tenant. The response returns the job ID of the processing job or dispatching job. + + :param admin_jobs_processing_job_request_dto: (required) + :type admin_jobs_processing_job_request_dto: AdminJobsProcessingJobRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._adhoc_processing_jobs_serialize( + admin_jobs_processing_job_request_dto=admin_jobs_processing_job_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingJobIdResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _adhoc_processing_jobs_serialize( + self, + admin_jobs_processing_job_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_jobs_processing_job_request_dto is not None: + _body_params = admin_jobs_processing_job_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/op/jobs/processing-jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def assign_connector_credential( + self, + data_in_assign_connector_credential_request: DataInAssignConnectorCredentialRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminAssignConnectorCredentialsResponseDTO: + """Assign connector credentials to data connectors + + Assign a connector credential to a data connector. + + :param data_in_assign_connector_credential_request: (required) + :type data_in_assign_connector_credential_request: DataInAssignConnectorCredentialRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_connector_credential_serialize( + data_in_assign_connector_credential_request=data_in_assign_connector_credential_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminAssignConnectorCredentialsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def assign_connector_credential_with_http_info( + self, + data_in_assign_connector_credential_request: DataInAssignConnectorCredentialRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminAssignConnectorCredentialsResponseDTO]: + """Assign connector credentials to data connectors + + Assign a connector credential to a data connector. + + :param data_in_assign_connector_credential_request: (required) + :type data_in_assign_connector_credential_request: DataInAssignConnectorCredentialRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_connector_credential_serialize( + data_in_assign_connector_credential_request=data_in_assign_connector_credential_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminAssignConnectorCredentialsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def assign_connector_credential_without_preload_content( + self, + data_in_assign_connector_credential_request: DataInAssignConnectorCredentialRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Assign connector credentials to data connectors + + Assign a connector credential to a data connector. + + :param data_in_assign_connector_credential_request: (required) + :type data_in_assign_connector_credential_request: DataInAssignConnectorCredentialRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_connector_credential_serialize( + data_in_assign_connector_credential_request=data_in_assign_connector_credential_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminAssignConnectorCredentialsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _assign_connector_credential_serialize( + self, + data_in_assign_connector_credential_request, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if data_in_assign_connector_credential_request is not None: + _body_params = data_in_assign_connector_credential_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/op/data-connectors/assignCredentials', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def cancel_jobs( + self, + dp_cancel_job_batch_from_job_id_dto: DpCancelJobBatchFromJobIdDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DpJobCancellationResultsDTO: + """Cancel a list of jobs + + Cancel a list of processing jobs, upload jobs, receiving jobs, and extraction jobs. **Note:** Receiving jobs with the Running status cannot be cancelled. + + :param dp_cancel_job_batch_from_job_id_dto: (required) + :type dp_cancel_job_batch_from_job_id_dto: DpCancelJobBatchFromJobIdDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._cancel_jobs_serialize( + dp_cancel_job_batch_from_job_id_dto=dp_cancel_job_batch_from_job_id_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DpJobCancellationResultsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def cancel_jobs_with_http_info( + self, + dp_cancel_job_batch_from_job_id_dto: DpCancelJobBatchFromJobIdDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DpJobCancellationResultsDTO]: + """Cancel a list of jobs + + Cancel a list of processing jobs, upload jobs, receiving jobs, and extraction jobs. **Note:** Receiving jobs with the Running status cannot be cancelled. + + :param dp_cancel_job_batch_from_job_id_dto: (required) + :type dp_cancel_job_batch_from_job_id_dto: DpCancelJobBatchFromJobIdDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._cancel_jobs_serialize( + dp_cancel_job_batch_from_job_id_dto=dp_cancel_job_batch_from_job_id_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DpJobCancellationResultsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def cancel_jobs_without_preload_content( + self, + dp_cancel_job_batch_from_job_id_dto: DpCancelJobBatchFromJobIdDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Cancel a list of jobs + + Cancel a list of processing jobs, upload jobs, receiving jobs, and extraction jobs. **Note:** Receiving jobs with the Running status cannot be cancelled. + + :param dp_cancel_job_batch_from_job_id_dto: (required) + :type dp_cancel_job_batch_from_job_id_dto: DpCancelJobBatchFromJobIdDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._cancel_jobs_serialize( + dp_cancel_job_batch_from_job_id_dto=dp_cancel_job_batch_from_job_id_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DpJobCancellationResultsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _cancel_jobs_serialize( + self, + dp_cancel_job_batch_from_job_id_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if dp_cancel_job_batch_from_job_id_dto is not None: + _body_params = dp_cancel_job_batch_from_job_id_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/op/jobs/cancel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_connector_credential( + self, + designer_data_provider_auth_information_dto: DesignerDataProviderAuthInformationDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to create the credential for.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerCredentialCreationAPIResponseDTO: + """Create a connector credential + + Create credentials for a data connector. Connector credentials allow Visier to retrieve data from your source systems through an integration user in the source system. In the request body, specify one data provider in the `dataProviderAuthParams` parameter. For example, to create connector credentials for a UKG data connector, your request body might look like the following sample. ```json { model={ \"dataProviderAuthParams\": { \"provider\": \"UKG\", \"ultimateAuthParams\": { \"hostDomainName\": \"exampleHostDomain\", \"apiKey\": \"apiKey1234\", \"username\": \"username1234\", \"password\": \"password1234\", \"userAccessKey\": \"accessKey1234\" } }, \"dataProviderBasicInformation\": { \"displayName\": \"exampleDisplayName\", \"description\": \"exampleDescription\" } } ``` + + :param designer_data_provider_auth_information_dto: (required) + :type designer_data_provider_auth_information_dto: DesignerDataProviderAuthInformationDTO + :param tenant_code: The tenant code of a specific analytic tenant that you want to create the credential for. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_connector_credential_serialize( + designer_data_provider_auth_information_dto=designer_data_provider_auth_information_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCredentialCreationAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_connector_credential_with_http_info( + self, + designer_data_provider_auth_information_dto: DesignerDataProviderAuthInformationDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to create the credential for.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerCredentialCreationAPIResponseDTO]: + """Create a connector credential + + Create credentials for a data connector. Connector credentials allow Visier to retrieve data from your source systems through an integration user in the source system. In the request body, specify one data provider in the `dataProviderAuthParams` parameter. For example, to create connector credentials for a UKG data connector, your request body might look like the following sample. ```json { model={ \"dataProviderAuthParams\": { \"provider\": \"UKG\", \"ultimateAuthParams\": { \"hostDomainName\": \"exampleHostDomain\", \"apiKey\": \"apiKey1234\", \"username\": \"username1234\", \"password\": \"password1234\", \"userAccessKey\": \"accessKey1234\" } }, \"dataProviderBasicInformation\": { \"displayName\": \"exampleDisplayName\", \"description\": \"exampleDescription\" } } ``` + + :param designer_data_provider_auth_information_dto: (required) + :type designer_data_provider_auth_information_dto: DesignerDataProviderAuthInformationDTO + :param tenant_code: The tenant code of a specific analytic tenant that you want to create the credential for. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_connector_credential_serialize( + designer_data_provider_auth_information_dto=designer_data_provider_auth_information_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCredentialCreationAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_connector_credential_without_preload_content( + self, + designer_data_provider_auth_information_dto: DesignerDataProviderAuthInformationDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to create the credential for.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a connector credential + + Create credentials for a data connector. Connector credentials allow Visier to retrieve data from your source systems through an integration user in the source system. In the request body, specify one data provider in the `dataProviderAuthParams` parameter. For example, to create connector credentials for a UKG data connector, your request body might look like the following sample. ```json { model={ \"dataProviderAuthParams\": { \"provider\": \"UKG\", \"ultimateAuthParams\": { \"hostDomainName\": \"exampleHostDomain\", \"apiKey\": \"apiKey1234\", \"username\": \"username1234\", \"password\": \"password1234\", \"userAccessKey\": \"accessKey1234\" } }, \"dataProviderBasicInformation\": { \"displayName\": \"exampleDisplayName\", \"description\": \"exampleDescription\" } } ``` + + :param designer_data_provider_auth_information_dto: (required) + :type designer_data_provider_auth_information_dto: DesignerDataProviderAuthInformationDTO + :param tenant_code: The tenant code of a specific analytic tenant that you want to create the credential for. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_connector_credential_serialize( + designer_data_provider_auth_information_dto=designer_data_provider_auth_information_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCredentialCreationAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_connector_credential_serialize( + self, + designer_data_provider_auth_information_dto, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if designer_data_provider_auth_information_dto is not None: + _body_params = designer_data_provider_auth_information_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/op/data-connector-credentials', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def data_connector_credentials( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve for.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerExtractorCredentialsAPIDTO: + """Retrieve a list of all data connector credentials + + Retrieve a list of the connector credentials in a specified tenant. Connector credentials allow Visier to retrieve data from your source systems through an integration user in the source system. + + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve for. + :type tenant_code: str + :param limit: The limit to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._data_connector_credentials_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerExtractorCredentialsAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def data_connector_credentials_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve for.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerExtractorCredentialsAPIDTO]: + """Retrieve a list of all data connector credentials + + Retrieve a list of the connector credentials in a specified tenant. Connector credentials allow Visier to retrieve data from your source systems through an integration user in the source system. + + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve for. + :type tenant_code: str + :param limit: The limit to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._data_connector_credentials_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerExtractorCredentialsAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def data_connector_credentials_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve for.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all data connector credentials + + Retrieve a list of the connector credentials in a specified tenant. Connector credentials allow Visier to retrieve data from your source systems through an integration user in the source system. + + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve for. + :type tenant_code: str + :param limit: The limit to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._data_connector_credentials_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerExtractorCredentialsAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _data_connector_credentials_serialize( + self, + tenant_code, + limit, + start, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/data-connector-credentials', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def data_connectors( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve for.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminDataImportDefinitionsAPIDTO: + """Retrieve a list of all data connectors + + Retrieve a list of the data connectors in a specified tenant. Data connectors are an alternative to generating flat files and transferring them to Visier via SFTP. + + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve for. + :type tenant_code: str + :param limit: The limit to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._data_connectors_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminDataImportDefinitionsAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def data_connectors_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve for.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminDataImportDefinitionsAPIDTO]: + """Retrieve a list of all data connectors + + Retrieve a list of the data connectors in a specified tenant. Data connectors are an alternative to generating flat files and transferring them to Visier via SFTP. + + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve for. + :type tenant_code: str + :param limit: The limit to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._data_connectors_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminDataImportDefinitionsAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def data_connectors_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve for.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all data connectors + + Retrieve a list of the data connectors in a specified tenant. Data connectors are an alternative to generating flat files and transferring them to Visier via SFTP. + + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve for. + :type tenant_code: str + :param limit: The limit to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._data_connectors_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminDataImportDefinitionsAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _data_connectors_serialize( + self, + tenant_code, + limit, + start, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/data-connectors', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_connector_credential( + self, + id: Annotated[StrictStr, Field(description="The credentialId of the credential you want to delete.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of the analytic tenant in which the credential you're deleting.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> str: + """Delete a connector credential + + Use this API to delete connector credentials from your tenants. Credentials that are no longer valid should be deleted. + + :param id: The credentialId of the credential you want to delete. (required) + :type id: str + :param tenant_code: The tenant code of the analytic tenant in which the credential you're deleting. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_connector_credential_serialize( + id=id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_connector_credential_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The credentialId of the credential you want to delete.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of the analytic tenant in which the credential you're deleting.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[str]: + """Delete a connector credential + + Use this API to delete connector credentials from your tenants. Credentials that are no longer valid should be deleted. + + :param id: The credentialId of the credential you want to delete. (required) + :type id: str + :param tenant_code: The tenant code of the analytic tenant in which the credential you're deleting. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_connector_credential_serialize( + id=id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_connector_credential_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The credentialId of the credential you want to delete.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of the analytic tenant in which the credential you're deleting.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a connector credential + + Use this API to delete connector credentials from your tenants. Credentials that are no longer valid should be deleted. + + :param id: The credentialId of the credential you want to delete. (required) + :type id: str + :param tenant_code: The tenant code of the analytic tenant in which the credential you're deleting. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_connector_credential_serialize( + id=id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_connector_credential_serialize( + self, + id, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/op/data-connector-credentials/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def disable_dv( + self, + data_in_disable_dv_request: DataInDisableDVRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInDisableDVResponse: + """Disable data versions for a list of analytic tenants + + If you discover that a data version is not what is expected after running metric value validation on a data load, you may want to disable the data version for that processing job. Disable the latest enabled data versions for affected analytic tenants or to disable a particular data version for each analytic tenant. **Note:** Disabling an older data version may not have an effect on the state of the solution. + + :param data_in_disable_dv_request: (required) + :type data_in_disable_dv_request: DataInDisableDVRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._disable_dv_serialize( + data_in_disable_dv_request=data_in_disable_dv_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInDisableDVResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def disable_dv_with_http_info( + self, + data_in_disable_dv_request: DataInDisableDVRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInDisableDVResponse]: + """Disable data versions for a list of analytic tenants + + If you discover that a data version is not what is expected after running metric value validation on a data load, you may want to disable the data version for that processing job. Disable the latest enabled data versions for affected analytic tenants or to disable a particular data version for each analytic tenant. **Note:** Disabling an older data version may not have an effect on the state of the solution. + + :param data_in_disable_dv_request: (required) + :type data_in_disable_dv_request: DataInDisableDVRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._disable_dv_serialize( + data_in_disable_dv_request=data_in_disable_dv_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInDisableDVResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def disable_dv_without_preload_content( + self, + data_in_disable_dv_request: DataInDisableDVRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Disable data versions for a list of analytic tenants + + If you discover that a data version is not what is expected after running metric value validation on a data load, you may want to disable the data version for that processing job. Disable the latest enabled data versions for affected analytic tenants or to disable a particular data version for each analytic tenant. **Note:** Disabling an older data version may not have an effect on the state of the solution. + + :param data_in_disable_dv_request: (required) + :type data_in_disable_dv_request: DataInDisableDVRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._disable_dv_serialize( + data_in_disable_dv_request=data_in_disable_dv_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInDisableDVResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _disable_dv_serialize( + self, + data_in_disable_dv_request, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if data_in_disable_dv_request is not None: + _body_params = data_in_disable_dv_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/op/data-versions/disable', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def dispatching_job_status( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the job you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInDispatchingJobStatusResponse: + """Retrieve a dispatching job's status + + Retrieve the status of a dispatching job, including its job ID and the number of jobs it generated. + + :param job_id: The ID of the job you want to retrieve. (required) + :type job_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dispatching_job_status_serialize( + job_id=job_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInDispatchingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def dispatching_job_status_with_http_info( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the job you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInDispatchingJobStatusResponse]: + """Retrieve a dispatching job's status + + Retrieve the status of a dispatching job, including its job ID and the number of jobs it generated. + + :param job_id: The ID of the job you want to retrieve. (required) + :type job_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dispatching_job_status_serialize( + job_id=job_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInDispatchingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def dispatching_job_status_without_preload_content( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the job you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a dispatching job's status + + Retrieve the status of a dispatching job, including its job ID and the number of jobs it generated. + + :param job_id: The ID of the job you want to retrieve. (required) + :type job_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dispatching_job_status_serialize( + job_id=job_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInDispatchingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _dispatching_job_status_serialize( + self, + job_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if job_id is not None: + _path_params['jobId'] = job_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/jobs/dispatching-jobs/{jobId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def exclude_data_uplaods( + self, + data_in_exclude_data_uploads_request: DataInExcludeDataUploadsRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingTenantDataUploadsUpdateResponseDTO: + """Exclude data uploads + + Exclude either a specified list of data uploads or all data uploads for each analytic tenant. + + :param data_in_exclude_data_uploads_request: (required) + :type data_in_exclude_data_uploads_request: DataInExcludeDataUploadsRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._exclude_data_uplaods_serialize( + data_in_exclude_data_uploads_request=data_in_exclude_data_uploads_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingTenantDataUploadsUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def exclude_data_uplaods_with_http_info( + self, + data_in_exclude_data_uploads_request: DataInExcludeDataUploadsRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingTenantDataUploadsUpdateResponseDTO]: + """Exclude data uploads + + Exclude either a specified list of data uploads or all data uploads for each analytic tenant. + + :param data_in_exclude_data_uploads_request: (required) + :type data_in_exclude_data_uploads_request: DataInExcludeDataUploadsRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._exclude_data_uplaods_serialize( + data_in_exclude_data_uploads_request=data_in_exclude_data_uploads_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingTenantDataUploadsUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def exclude_data_uplaods_without_preload_content( + self, + data_in_exclude_data_uploads_request: DataInExcludeDataUploadsRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Exclude data uploads + + Exclude either a specified list of data uploads or all data uploads for each analytic tenant. + + :param data_in_exclude_data_uploads_request: (required) + :type data_in_exclude_data_uploads_request: DataInExcludeDataUploadsRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._exclude_data_uplaods_serialize( + data_in_exclude_data_uploads_request=data_in_exclude_data_uploads_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingTenantDataUploadsUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _exclude_data_uplaods_serialize( + self, + data_in_exclude_data_uploads_request, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if data_in_exclude_data_uploads_request is not None: + _body_params = data_in_exclude_data_uploads_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/op/data/uploads/exclude', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def extraction_job_and_status( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the dispatching job you want to retrieve.")], + dispatching_job_id: Annotated[Optional[StrictStr], Field(description="The ID of the dispatching job that generated the extraction jobs.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of extraction job statuses to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInExtractionJobAndStatusResponse: + """Retrieve a dispatching job's extraction jobs with their statuses + + Retrieve the statuses of extraction jobs associated with a dispatching job. The dispatching job is a \"parent\" to extraction jobs, which retrieve data from your source systems through data connectors. + + :param job_id: The ID of the dispatching job you want to retrieve. (required) + :type job_id: str + :param dispatching_job_id: The ID of the dispatching job that generated the extraction jobs. + :type dispatching_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of extraction job statuses to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._extraction_job_and_status_serialize( + job_id=job_id, + dispatching_job_id=dispatching_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInExtractionJobAndStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def extraction_job_and_status_with_http_info( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the dispatching job you want to retrieve.")], + dispatching_job_id: Annotated[Optional[StrictStr], Field(description="The ID of the dispatching job that generated the extraction jobs.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of extraction job statuses to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInExtractionJobAndStatusResponse]: + """Retrieve a dispatching job's extraction jobs with their statuses + + Retrieve the statuses of extraction jobs associated with a dispatching job. The dispatching job is a \"parent\" to extraction jobs, which retrieve data from your source systems through data connectors. + + :param job_id: The ID of the dispatching job you want to retrieve. (required) + :type job_id: str + :param dispatching_job_id: The ID of the dispatching job that generated the extraction jobs. + :type dispatching_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of extraction job statuses to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._extraction_job_and_status_serialize( + job_id=job_id, + dispatching_job_id=dispatching_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInExtractionJobAndStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def extraction_job_and_status_without_preload_content( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the dispatching job you want to retrieve.")], + dispatching_job_id: Annotated[Optional[StrictStr], Field(description="The ID of the dispatching job that generated the extraction jobs.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of extraction job statuses to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a dispatching job's extraction jobs with their statuses + + Retrieve the statuses of extraction jobs associated with a dispatching job. The dispatching job is a \"parent\" to extraction jobs, which retrieve data from your source systems through data connectors. + + :param job_id: The ID of the dispatching job you want to retrieve. (required) + :type job_id: str + :param dispatching_job_id: The ID of the dispatching job that generated the extraction jobs. + :type dispatching_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of extraction job statuses to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._extraction_job_and_status_serialize( + job_id=job_id, + dispatching_job_id=dispatching_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInExtractionJobAndStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _extraction_job_and_status_serialize( + self, + job_id, + dispatching_job_id, + tenant_code, + limit, + start, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if job_id is not None: + _path_params['jobId'] = job_id + # process the query parameters + if dispatching_job_id is not None: + + _query_params.append(('dispatchingJobId', dispatching_job_id)) + + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/jobs/dispatching-jobs/{jobId}/extraction-jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def include_data_uploads( + self, + data_in_include_data_uploads_request: DataInIncludeDataUploadsRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingTenantDataUploadsUpdateResponseDTO: + """Include data uploads + + Include either the specified list of data uploads or all data uploads for each analytic tenant. + + :param data_in_include_data_uploads_request: (required) + :type data_in_include_data_uploads_request: DataInIncludeDataUploadsRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._include_data_uploads_serialize( + data_in_include_data_uploads_request=data_in_include_data_uploads_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingTenantDataUploadsUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def include_data_uploads_with_http_info( + self, + data_in_include_data_uploads_request: DataInIncludeDataUploadsRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingTenantDataUploadsUpdateResponseDTO]: + """Include data uploads + + Include either the specified list of data uploads or all data uploads for each analytic tenant. + + :param data_in_include_data_uploads_request: (required) + :type data_in_include_data_uploads_request: DataInIncludeDataUploadsRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._include_data_uploads_serialize( + data_in_include_data_uploads_request=data_in_include_data_uploads_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingTenantDataUploadsUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def include_data_uploads_without_preload_content( + self, + data_in_include_data_uploads_request: DataInIncludeDataUploadsRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Include data uploads + + Include either the specified list of data uploads or all data uploads for each analytic tenant. + + :param data_in_include_data_uploads_request: (required) + :type data_in_include_data_uploads_request: DataInIncludeDataUploadsRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._include_data_uploads_serialize( + data_in_include_data_uploads_request=data_in_include_data_uploads_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingTenantDataUploadsUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _include_data_uploads_serialize( + self, + data_in_include_data_uploads_request, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if data_in_include_data_uploads_request is not None: + _body_params = data_in_include_data_uploads_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/op/data/uploads/include', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def job_id_status( + self, + job_id: Annotated[StrictStr, Field(description="The unique ID of the job to retrieve the status for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInReceivingJobStatusResponse: + """Retrieve a specific job's status + + Use this API to retrieve the list of statuses for a specific job with id `jobId`. You can retrieve all job statuses or specify a time period to retrieve statuses from. + + :param job_id: The unique ID of the job to retrieve the status for. (required) + :type job_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._job_id_status_serialize( + job_id=job_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInReceivingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def job_id_status_with_http_info( + self, + job_id: Annotated[StrictStr, Field(description="The unique ID of the job to retrieve the status for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInReceivingJobStatusResponse]: + """Retrieve a specific job's status + + Use this API to retrieve the list of statuses for a specific job with id `jobId`. You can retrieve all job statuses or specify a time period to retrieve statuses from. + + :param job_id: The unique ID of the job to retrieve the status for. (required) + :type job_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._job_id_status_serialize( + job_id=job_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInReceivingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def job_id_status_without_preload_content( + self, + job_id: Annotated[StrictStr, Field(description="The unique ID of the job to retrieve the status for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a specific job's status + + Use this API to retrieve the list of statuses for a specific job with id `jobId`. You can retrieve all job statuses or specify a time period to retrieve statuses from. + + :param job_id: The unique ID of the job to retrieve the status for. (required) + :type job_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._job_id_status_serialize( + job_id=job_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInReceivingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _job_id_status_serialize( + self, + job_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if job_id is not None: + _path_params['jobId'] = job_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/job-status/jobs/{jobId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def job_status( + self, + start_time: Annotated[Optional[StrictStr], Field(description="The start time from which to retrieve job statuses.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="The end time from which to retrieve job statuses.")] = None, + status: Annotated[Optional[StrictStr], Field(description="The specific status to restrict the list of jobs to.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInJobStatusListResponse: + """Retrieve the statuses of all jobs + + Retrieve the list of statuses for all jobs. + + :param start_time: The start time from which to retrieve job statuses. + :type start_time: str + :param end_time: The end time from which to retrieve job statuses. + :type end_time: str + :param status: The specific status to restrict the list of jobs to. + :type status: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._job_status_serialize( + start_time=start_time, + end_time=end_time, + status=status, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInJobStatusListResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def job_status_with_http_info( + self, + start_time: Annotated[Optional[StrictStr], Field(description="The start time from which to retrieve job statuses.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="The end time from which to retrieve job statuses.")] = None, + status: Annotated[Optional[StrictStr], Field(description="The specific status to restrict the list of jobs to.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInJobStatusListResponse]: + """Retrieve the statuses of all jobs + + Retrieve the list of statuses for all jobs. + + :param start_time: The start time from which to retrieve job statuses. + :type start_time: str + :param end_time: The end time from which to retrieve job statuses. + :type end_time: str + :param status: The specific status to restrict the list of jobs to. + :type status: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._job_status_serialize( + start_time=start_time, + end_time=end_time, + status=status, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInJobStatusListResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def job_status_without_preload_content( + self, + start_time: Annotated[Optional[StrictStr], Field(description="The start time from which to retrieve job statuses.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="The end time from which to retrieve job statuses.")] = None, + status: Annotated[Optional[StrictStr], Field(description="The specific status to restrict the list of jobs to.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the statuses of all jobs + + Retrieve the list of statuses for all jobs. + + :param start_time: The start time from which to retrieve job statuses. + :type start_time: str + :param end_time: The end time from which to retrieve job statuses. + :type end_time: str + :param status: The specific status to restrict the list of jobs to. + :type status: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._job_status_serialize( + start_time=start_time, + end_time=end_time, + status=status, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInJobStatusListResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _job_status_serialize( + self, + start_time, + end_time, + status, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if start_time is not None: + + _query_params.append(('startTime', start_time)) + + if end_time is not None: + + _query_params.append(('endTime', end_time)) + + if status is not None: + + _query_params.append(('status', status)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/job-status/jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def latest_enabled_dv( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve data versions for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenants to retrieve data versions for. This parameter is not used if the tenantCode parameter is specified.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + number_of_versions: Annotated[Optional[StrictInt], Field(description="The number of latest enabled data versions to retrieve. The maximum value is 5.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminMultipleTenantDataVersionsListDTO: + """Retrieve the latest enabled data versions for all analytic tenants + + If you discover any inconsistencies after running metric value validation, you may want to find the data versions causing inconsistencies so you can later disable them. Retrieve up to five (5) of the latest enabled data versions for all your analytic tenants or a single specified analytic tenant. + + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve data versions for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of analytic tenants to retrieve data versions for. This parameter is not used if the tenantCode parameter is specified. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param number_of_versions: The number of latest enabled data versions to retrieve. The maximum value is 5. + :type number_of_versions: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._latest_enabled_dv_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + number_of_versions=number_of_versions, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminMultipleTenantDataVersionsListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def latest_enabled_dv_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve data versions for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenants to retrieve data versions for. This parameter is not used if the tenantCode parameter is specified.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + number_of_versions: Annotated[Optional[StrictInt], Field(description="The number of latest enabled data versions to retrieve. The maximum value is 5.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminMultipleTenantDataVersionsListDTO]: + """Retrieve the latest enabled data versions for all analytic tenants + + If you discover any inconsistencies after running metric value validation, you may want to find the data versions causing inconsistencies so you can later disable them. Retrieve up to five (5) of the latest enabled data versions for all your analytic tenants or a single specified analytic tenant. + + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve data versions for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of analytic tenants to retrieve data versions for. This parameter is not used if the tenantCode parameter is specified. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param number_of_versions: The number of latest enabled data versions to retrieve. The maximum value is 5. + :type number_of_versions: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._latest_enabled_dv_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + number_of_versions=number_of_versions, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminMultipleTenantDataVersionsListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def latest_enabled_dv_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve data versions for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenants to retrieve data versions for. This parameter is not used if the tenantCode parameter is specified.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + number_of_versions: Annotated[Optional[StrictInt], Field(description="The number of latest enabled data versions to retrieve. The maximum value is 5.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the latest enabled data versions for all analytic tenants + + If you discover any inconsistencies after running metric value validation, you may want to find the data versions causing inconsistencies so you can later disable them. Retrieve up to five (5) of the latest enabled data versions for all your analytic tenants or a single specified analytic tenant. + + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve data versions for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of analytic tenants to retrieve data versions for. This parameter is not used if the tenantCode parameter is specified. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param number_of_versions: The number of latest enabled data versions to retrieve. The maximum value is 5. + :type number_of_versions: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._latest_enabled_dv_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + number_of_versions=number_of_versions, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminMultipleTenantDataVersionsListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _latest_enabled_dv_serialize( + self, + tenant_code, + limit, + start, + number_of_versions, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + if number_of_versions is not None: + + _query_params.append(('numberOfVersions', number_of_versions)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/data-versions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_connector_settings( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminExtractorSettingsAPIDTO: + """Retrieve data connector settings + + Get a list of settings for all data connectors. This request retrieves data connectors from the production environment. The response returns a list of settings, if available, for each data connector in the tenant. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_connector_settings_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminExtractorSettingsAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_connector_settings_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminExtractorSettingsAPIDTO]: + """Retrieve data connector settings + + Get a list of settings for all data connectors. This request retrieves data connectors from the production environment. The response returns a list of settings, if available, for each data connector in the tenant. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_connector_settings_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminExtractorSettingsAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_connector_settings_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve data connector settings + + Get a list of settings for all data connectors. This request retrieves data connectors from the production environment. The response returns a list of settings, if available, for each data connector in the tenant. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_connector_settings_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminExtractorSettingsAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_connector_settings_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/data-connectors/connector-settings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def processing_job_and_status( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the dispatching job you want to retrieve.")], + dispatching_job_id: Annotated[Optional[StrictStr], Field(description="The ID of the dispatching job that generated the extraction jobs.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of extraction job statuses to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInProcessingJobAndStatusResponse: + """Retrieve a dispatching job's processing jobs with their statuses + + Retrieve the statuses of processing jobs associated with a dispatching job. The dispatching job is a \"parent\" to extraction jobs, which in turn generate processing jobs and receiving jobs. + + :param job_id: The ID of the dispatching job you want to retrieve. (required) + :type job_id: str + :param dispatching_job_id: The ID of the dispatching job that generated the extraction jobs. + :type dispatching_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of extraction job statuses to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._processing_job_and_status_serialize( + job_id=job_id, + dispatching_job_id=dispatching_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInProcessingJobAndStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def processing_job_and_status_with_http_info( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the dispatching job you want to retrieve.")], + dispatching_job_id: Annotated[Optional[StrictStr], Field(description="The ID of the dispatching job that generated the extraction jobs.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of extraction job statuses to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInProcessingJobAndStatusResponse]: + """Retrieve a dispatching job's processing jobs with their statuses + + Retrieve the statuses of processing jobs associated with a dispatching job. The dispatching job is a \"parent\" to extraction jobs, which in turn generate processing jobs and receiving jobs. + + :param job_id: The ID of the dispatching job you want to retrieve. (required) + :type job_id: str + :param dispatching_job_id: The ID of the dispatching job that generated the extraction jobs. + :type dispatching_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of extraction job statuses to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._processing_job_and_status_serialize( + job_id=job_id, + dispatching_job_id=dispatching_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInProcessingJobAndStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def processing_job_and_status_without_preload_content( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the dispatching job you want to retrieve.")], + dispatching_job_id: Annotated[Optional[StrictStr], Field(description="The ID of the dispatching job that generated the extraction jobs.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of extraction job statuses to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a dispatching job's processing jobs with their statuses + + Retrieve the statuses of processing jobs associated with a dispatching job. The dispatching job is a \"parent\" to extraction jobs, which in turn generate processing jobs and receiving jobs. + + :param job_id: The ID of the dispatching job you want to retrieve. (required) + :type job_id: str + :param dispatching_job_id: The ID of the dispatching job that generated the extraction jobs. + :type dispatching_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of extraction job statuses to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._processing_job_and_status_serialize( + job_id=job_id, + dispatching_job_id=dispatching_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInProcessingJobAndStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _processing_job_and_status_serialize( + self, + job_id, + dispatching_job_id, + tenant_code, + limit, + start, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if job_id is not None: + _path_params['jobId'] = job_id + # process the query parameters + if dispatching_job_id is not None: + + _query_params.append(('dispatchingJobId', dispatching_job_id)) + + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/jobs/dispatching-jobs/{jobId}/processing-jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def processing_job_status( + self, + receiving_job_id: Annotated[StrictStr, Field(description="The receiving job ID")], + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of the tenant you want to retrieve the processing jobs for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of processing jobs to retrieve per page.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInProcessingJobStatusResponse: + """Retrieve processing job statuses by receiving job ID + + Retrieve a list of statuses for all processing jobs associated with the given receiving job ID. Processing jobs deal with an individual analytic tenant's data load. A processing job is either triggered through the UI or is one of many processing jobs spawned from a receiving job. When a processing job is triggered as part of a set from an receiving job, it is associated to the receiving job through a Parent ID. + + :param receiving_job_id: The receiving job ID (required) + :type receiving_job_id: str + :param tenant_code: The tenant code of the tenant you want to retrieve the processing jobs for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of processing jobs to retrieve per page. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._processing_job_status_serialize( + receiving_job_id=receiving_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInProcessingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def processing_job_status_with_http_info( + self, + receiving_job_id: Annotated[StrictStr, Field(description="The receiving job ID")], + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of the tenant you want to retrieve the processing jobs for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of processing jobs to retrieve per page.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInProcessingJobStatusResponse]: + """Retrieve processing job statuses by receiving job ID + + Retrieve a list of statuses for all processing jobs associated with the given receiving job ID. Processing jobs deal with an individual analytic tenant's data load. A processing job is either triggered through the UI or is one of many processing jobs spawned from a receiving job. When a processing job is triggered as part of a set from an receiving job, it is associated to the receiving job through a Parent ID. + + :param receiving_job_id: The receiving job ID (required) + :type receiving_job_id: str + :param tenant_code: The tenant code of the tenant you want to retrieve the processing jobs for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of processing jobs to retrieve per page. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._processing_job_status_serialize( + receiving_job_id=receiving_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInProcessingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def processing_job_status_without_preload_content( + self, + receiving_job_id: Annotated[StrictStr, Field(description="The receiving job ID")], + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of the tenant you want to retrieve the processing jobs for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of processing jobs to retrieve per page.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve processing job statuses by receiving job ID + + Retrieve a list of statuses for all processing jobs associated with the given receiving job ID. Processing jobs deal with an individual analytic tenant's data load. A processing job is either triggered through the UI or is one of many processing jobs spawned from a receiving job. When a processing job is triggered as part of a set from an receiving job, it is associated to the receiving job through a Parent ID. + + :param receiving_job_id: The receiving job ID (required) + :type receiving_job_id: str + :param tenant_code: The tenant code of the tenant you want to retrieve the processing jobs for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of processing jobs to retrieve per page. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._processing_job_status_serialize( + receiving_job_id=receiving_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInProcessingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _processing_job_status_serialize( + self, + receiving_job_id, + tenant_code, + limit, + start, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if receiving_job_id is not None: + _path_params['receivingJobId'] = receiving_job_id + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/jobs/processing-jobs/{receivingJobId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def receiving_job_and_status( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the dispatching job you want to retrieve.")], + dispatching_job_id: Annotated[Optional[StrictStr], Field(description="The ID of the dispatching job that generated the extraction jobs.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of extraction job statuses to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInReceivingJobAndStatusResponse: + """Retrieve a dispatching job's receiving jobs with their statuses + + Retrieve the statuses of receiving jobs associated with a dispatching job. The dispatching job is a \"parent\" to extraction jobs, which in turn generate processing jobs and receiving jobs. + + :param job_id: The ID of the dispatching job you want to retrieve. (required) + :type job_id: str + :param dispatching_job_id: The ID of the dispatching job that generated the extraction jobs. + :type dispatching_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of extraction job statuses to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._receiving_job_and_status_serialize( + job_id=job_id, + dispatching_job_id=dispatching_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInReceivingJobAndStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def receiving_job_and_status_with_http_info( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the dispatching job you want to retrieve.")], + dispatching_job_id: Annotated[Optional[StrictStr], Field(description="The ID of the dispatching job that generated the extraction jobs.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of extraction job statuses to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInReceivingJobAndStatusResponse]: + """Retrieve a dispatching job's receiving jobs with their statuses + + Retrieve the statuses of receiving jobs associated with a dispatching job. The dispatching job is a \"parent\" to extraction jobs, which in turn generate processing jobs and receiving jobs. + + :param job_id: The ID of the dispatching job you want to retrieve. (required) + :type job_id: str + :param dispatching_job_id: The ID of the dispatching job that generated the extraction jobs. + :type dispatching_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of extraction job statuses to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._receiving_job_and_status_serialize( + job_id=job_id, + dispatching_job_id=dispatching_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInReceivingJobAndStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def receiving_job_and_status_without_preload_content( + self, + job_id: Annotated[StrictStr, Field(description="The ID of the dispatching job you want to retrieve.")], + dispatching_job_id: Annotated[Optional[StrictStr], Field(description="The ID of the dispatching job that generated the extraction jobs.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of extraction job statuses to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a dispatching job's receiving jobs with their statuses + + Retrieve the statuses of receiving jobs associated with a dispatching job. The dispatching job is a \"parent\" to extraction jobs, which in turn generate processing jobs and receiving jobs. + + :param job_id: The ID of the dispatching job you want to retrieve. (required) + :type job_id: str + :param dispatching_job_id: The ID of the dispatching job that generated the extraction jobs. + :type dispatching_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the extraction job status for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param limit: The limit of extraction job statuses to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._receiving_job_and_status_serialize( + job_id=job_id, + dispatching_job_id=dispatching_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInReceivingJobAndStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _receiving_job_and_status_serialize( + self, + job_id, + dispatching_job_id, + tenant_code, + limit, + start, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if job_id is not None: + _path_params['jobId'] = job_id + # process the query parameters + if dispatching_job_id is not None: + + _query_params.append(('dispatchingJobId', dispatching_job_id)) + + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/jobs/dispatching-jobs/{jobId}/receiving-jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def receiving_job_status( + self, + receiving_job_id: Annotated[StrictStr, Field(description="The jobId provided after sending data to Visier.")], + jobs: Annotated[Optional[StrictBool], Field(description="If `true`, returns the status of receiving jobs spawned by the receiving job specified by `jobId`.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of the tenant you want to retrieve the receiving jobs for. Use this if you are only interested in the results for one analytic tenant.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of job statuses to return per page.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInReceivingJobStatusResponse: + """Retrieve a receiving job's status + + After sending data to Visier, you may want to know the status of the receiving job and the associated tenant receiving jobs. A receiving job validates the transferred data and adds the transferred data to Visier's data store. A successful response indicates that the receiving job was successful. To get the status of the jobs spawned by the receiving job, set the `jobs` parameter to `true`. + + :param receiving_job_id: The jobId provided after sending data to Visier. (required) + :type receiving_job_id: str + :param jobs: If `true`, returns the status of receiving jobs spawned by the receiving job specified by `jobId`. + :type jobs: bool + :param tenant_code: The tenant code of the tenant you want to retrieve the receiving jobs for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param limit: The number of job statuses to return per page. + :type limit: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._receiving_job_status_serialize( + receiving_job_id=receiving_job_id, + jobs=jobs, + tenant_code=tenant_code, + start=start, + limit=limit, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInReceivingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def receiving_job_status_with_http_info( + self, + receiving_job_id: Annotated[StrictStr, Field(description="The jobId provided after sending data to Visier.")], + jobs: Annotated[Optional[StrictBool], Field(description="If `true`, returns the status of receiving jobs spawned by the receiving job specified by `jobId`.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of the tenant you want to retrieve the receiving jobs for. Use this if you are only interested in the results for one analytic tenant.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of job statuses to return per page.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInReceivingJobStatusResponse]: + """Retrieve a receiving job's status + + After sending data to Visier, you may want to know the status of the receiving job and the associated tenant receiving jobs. A receiving job validates the transferred data and adds the transferred data to Visier's data store. A successful response indicates that the receiving job was successful. To get the status of the jobs spawned by the receiving job, set the `jobs` parameter to `true`. + + :param receiving_job_id: The jobId provided after sending data to Visier. (required) + :type receiving_job_id: str + :param jobs: If `true`, returns the status of receiving jobs spawned by the receiving job specified by `jobId`. + :type jobs: bool + :param tenant_code: The tenant code of the tenant you want to retrieve the receiving jobs for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param limit: The number of job statuses to return per page. + :type limit: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._receiving_job_status_serialize( + receiving_job_id=receiving_job_id, + jobs=jobs, + tenant_code=tenant_code, + start=start, + limit=limit, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInReceivingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def receiving_job_status_without_preload_content( + self, + receiving_job_id: Annotated[StrictStr, Field(description="The jobId provided after sending data to Visier.")], + jobs: Annotated[Optional[StrictBool], Field(description="If `true`, returns the status of receiving jobs spawned by the receiving job specified by `jobId`.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The tenant code of the tenant you want to retrieve the receiving jobs for. Use this if you are only interested in the results for one analytic tenant.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of job statuses to return per page.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a receiving job's status + + After sending data to Visier, you may want to know the status of the receiving job and the associated tenant receiving jobs. A receiving job validates the transferred data and adds the transferred data to Visier's data store. A successful response indicates that the receiving job was successful. To get the status of the jobs spawned by the receiving job, set the `jobs` parameter to `true`. + + :param receiving_job_id: The jobId provided after sending data to Visier. (required) + :type receiving_job_id: str + :param jobs: If `true`, returns the status of receiving jobs spawned by the receiving job specified by `jobId`. + :type jobs: bool + :param tenant_code: The tenant code of the tenant you want to retrieve the receiving jobs for. Use this if you are only interested in the results for one analytic tenant. + :type tenant_code: str + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param limit: The number of job statuses to return per page. + :type limit: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._receiving_job_status_serialize( + receiving_job_id=receiving_job_id, + jobs=jobs, + tenant_code=tenant_code, + start=start, + limit=limit, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInReceivingJobStatusResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _receiving_job_status_serialize( + self, + receiving_job_id, + jobs, + tenant_code, + start, + limit, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if receiving_job_id is not None: + _path_params['receivingJobId'] = receiving_job_id + # process the query parameters + if jobs is not None: + + _query_params.append(('jobs', jobs)) + + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if start is not None: + + _query_params.append(('start', start)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/jobs/receiving-jobs/{receivingJobId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def retrieve_data_categories( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDataCategoriesResponseDTO: + """Retrieve a list of all data categories + + Retrieve a list of all available data categories. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_data_categories_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDataCategoriesResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def retrieve_data_categories_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDataCategoriesResponseDTO]: + """Retrieve a list of all data categories + + Retrieve a list of all available data categories. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_data_categories_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDataCategoriesResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def retrieve_data_categories_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all data categories + + Retrieve a list of all available data categories. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_data_categories_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDataCategoriesResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _retrieve_data_categories_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/data/categories', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def retrieve_data_uploads( + self, + upload_job_id: Annotated[Optional[StrictStr], Field(description="The job ID of an upload job. Use this if you are interested in the data uploads for a specific upload job.")] = None, + tenant_code: Annotated[Optional[StrictInt], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the data uploads for.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenants to retrieve data uploads for. This parameter is not used if the tenantCode parameter is specified. Default is 1000.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + number_of_data_uploads: Annotated[Optional[StrictInt], Field(description="The maximum number of latest enabled data uploads to retrieve for each analytic tenant. The maximum value is 5. Default is 1.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingTenantDataUploadsListResponseDTO: + """Retrieve data uploads + + Retrieve the data uploads and whether they're included in one of: - A list of analytic tenants managed by you. - A single specified analytic tenant. - An upload job. + + :param upload_job_id: The job ID of an upload job. Use this if you are interested in the data uploads for a specific upload job. + :type upload_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the data uploads for. + :type tenant_code: int + :param limit: The limit of analytic tenants to retrieve data uploads for. This parameter is not used if the tenantCode parameter is specified. Default is 1000. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param number_of_data_uploads: The maximum number of latest enabled data uploads to retrieve for each analytic tenant. The maximum value is 5. Default is 1. + :type number_of_data_uploads: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_data_uploads_serialize( + upload_job_id=upload_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + number_of_data_uploads=number_of_data_uploads, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingTenantDataUploadsListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def retrieve_data_uploads_with_http_info( + self, + upload_job_id: Annotated[Optional[StrictStr], Field(description="The job ID of an upload job. Use this if you are interested in the data uploads for a specific upload job.")] = None, + tenant_code: Annotated[Optional[StrictInt], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the data uploads for.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenants to retrieve data uploads for. This parameter is not used if the tenantCode parameter is specified. Default is 1000.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + number_of_data_uploads: Annotated[Optional[StrictInt], Field(description="The maximum number of latest enabled data uploads to retrieve for each analytic tenant. The maximum value is 5. Default is 1.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingTenantDataUploadsListResponseDTO]: + """Retrieve data uploads + + Retrieve the data uploads and whether they're included in one of: - A list of analytic tenants managed by you. - A single specified analytic tenant. - An upload job. + + :param upload_job_id: The job ID of an upload job. Use this if you are interested in the data uploads for a specific upload job. + :type upload_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the data uploads for. + :type tenant_code: int + :param limit: The limit of analytic tenants to retrieve data uploads for. This parameter is not used if the tenantCode parameter is specified. Default is 1000. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param number_of_data_uploads: The maximum number of latest enabled data uploads to retrieve for each analytic tenant. The maximum value is 5. Default is 1. + :type number_of_data_uploads: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_data_uploads_serialize( + upload_job_id=upload_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + number_of_data_uploads=number_of_data_uploads, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingTenantDataUploadsListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def retrieve_data_uploads_without_preload_content( + self, + upload_job_id: Annotated[Optional[StrictStr], Field(description="The job ID of an upload job. Use this if you are interested in the data uploads for a specific upload job.")] = None, + tenant_code: Annotated[Optional[StrictInt], Field(description="The tenant code of a specific analytic tenant that you want to retrieve the data uploads for.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenants to retrieve data uploads for. This parameter is not used if the tenantCode parameter is specified. Default is 1000.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + number_of_data_uploads: Annotated[Optional[StrictInt], Field(description="The maximum number of latest enabled data uploads to retrieve for each analytic tenant. The maximum value is 5. Default is 1.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve data uploads + + Retrieve the data uploads and whether they're included in one of: - A list of analytic tenants managed by you. - A single specified analytic tenant. - An upload job. + + :param upload_job_id: The job ID of an upload job. Use this if you are interested in the data uploads for a specific upload job. + :type upload_job_id: str + :param tenant_code: The tenant code of a specific analytic tenant that you want to retrieve the data uploads for. + :type tenant_code: int + :param limit: The limit of analytic tenants to retrieve data uploads for. This parameter is not used if the tenantCode parameter is specified. Default is 1000. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param number_of_data_uploads: The maximum number of latest enabled data uploads to retrieve for each analytic tenant. The maximum value is 5. Default is 1. + :type number_of_data_uploads: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._retrieve_data_uploads_serialize( + upload_job_id=upload_job_id, + tenant_code=tenant_code, + limit=limit, + start=start, + number_of_data_uploads=number_of_data_uploads, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingTenantDataUploadsListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _retrieve_data_uploads_serialize( + self, + upload_job_id, + tenant_code, + limit, + start, + number_of_data_uploads, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if upload_job_id is not None: + + _query_params.append(('uploadJobId', upload_job_id)) + + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + if number_of_data_uploads is not None: + + _query_params.append(('numberOfDataUploads', number_of_data_uploads)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/data/uploads', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def set_connector_setting( + self, + admin_set_connector_settings_request_dto: AdminSetConnectorSettingsRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminSetConnectorSettingsResponseDTO: + """Update data connector settings + + Define the settings for one or more data connectors. To find the available settings, see `Retrieve data connector settings`. + + :param admin_set_connector_settings_request_dto: (required) + :type admin_set_connector_settings_request_dto: AdminSetConnectorSettingsRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_connector_setting_serialize( + admin_set_connector_settings_request_dto=admin_set_connector_settings_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminSetConnectorSettingsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_connector_setting_with_http_info( + self, + admin_set_connector_settings_request_dto: AdminSetConnectorSettingsRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminSetConnectorSettingsResponseDTO]: + """Update data connector settings + + Define the settings for one or more data connectors. To find the available settings, see `Retrieve data connector settings`. + + :param admin_set_connector_settings_request_dto: (required) + :type admin_set_connector_settings_request_dto: AdminSetConnectorSettingsRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_connector_setting_serialize( + admin_set_connector_settings_request_dto=admin_set_connector_settings_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminSetConnectorSettingsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_connector_setting_without_preload_content( + self, + admin_set_connector_settings_request_dto: AdminSetConnectorSettingsRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update data connector settings + + Define the settings for one or more data connectors. To find the available settings, see `Retrieve data connector settings`. + + :param admin_set_connector_settings_request_dto: (required) + :type admin_set_connector_settings_request_dto: AdminSetConnectorSettingsRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_connector_setting_serialize( + admin_set_connector_settings_request_dto=admin_set_connector_settings_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminSetConnectorSettingsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_connector_setting_serialize( + self, + admin_set_connector_settings_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_set_connector_settings_request_dto is not None: + _body_params = admin_set_connector_settings_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/op/data-connectors/connector-settings', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def start_extraction( + self, + admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInStartExtractionResponse: + """Trigger data connector extraction jobs + + Run data connector extraction jobs for the administrating tenant or a list of analytic tenants. This API creates a dispatching job that generates one extraction job per tenant. The dispatching job is the \"parent\" of the extraction jobs and the dispatching job ID is returned in the response. Use that ID to monitor the extraction job statuses by calling `GET /v1/op/jobs/dispatching-jobs/{jobId}/extraction-jobs`. The extraction job generates receiving jobs to validate the data and processing jobs to populate data in the analytic tenants. Use the dispatching job ID to monitor the receiving and processing job statuses by calling `GET /v1/op/jobs/dispatching-jobs/{jobId}/receiving-jobs` or `GET /v1/op/jobs/dispatching-jobs/{jobId}/processing-jobs`. + + :param admin_jobs_extract_data_and_load_dto: (required) + :type admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_extraction_serialize( + admin_jobs_extract_data_and_load_dto=admin_jobs_extract_data_and_load_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInStartExtractionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def start_extraction_with_http_info( + self, + admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInStartExtractionResponse]: + """Trigger data connector extraction jobs + + Run data connector extraction jobs for the administrating tenant or a list of analytic tenants. This API creates a dispatching job that generates one extraction job per tenant. The dispatching job is the \"parent\" of the extraction jobs and the dispatching job ID is returned in the response. Use that ID to monitor the extraction job statuses by calling `GET /v1/op/jobs/dispatching-jobs/{jobId}/extraction-jobs`. The extraction job generates receiving jobs to validate the data and processing jobs to populate data in the analytic tenants. Use the dispatching job ID to monitor the receiving and processing job statuses by calling `GET /v1/op/jobs/dispatching-jobs/{jobId}/receiving-jobs` or `GET /v1/op/jobs/dispatching-jobs/{jobId}/processing-jobs`. + + :param admin_jobs_extract_data_and_load_dto: (required) + :type admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_extraction_serialize( + admin_jobs_extract_data_and_load_dto=admin_jobs_extract_data_and_load_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInStartExtractionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def start_extraction_without_preload_content( + self, + admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Trigger data connector extraction jobs + + Run data connector extraction jobs for the administrating tenant or a list of analytic tenants. This API creates a dispatching job that generates one extraction job per tenant. The dispatching job is the \"parent\" of the extraction jobs and the dispatching job ID is returned in the response. Use that ID to monitor the extraction job statuses by calling `GET /v1/op/jobs/dispatching-jobs/{jobId}/extraction-jobs`. The extraction job generates receiving jobs to validate the data and processing jobs to populate data in the analytic tenants. Use the dispatching job ID to monitor the receiving and processing job statuses by calling `GET /v1/op/jobs/dispatching-jobs/{jobId}/receiving-jobs` or `GET /v1/op/jobs/dispatching-jobs/{jobId}/processing-jobs`. + + :param admin_jobs_extract_data_and_load_dto: (required) + :type admin_jobs_extract_data_and_load_dto: AdminJobsExtractDataAndLoadDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_extraction_serialize( + admin_jobs_extract_data_and_load_dto=admin_jobs_extract_data_and_load_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInStartExtractionResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _start_extraction_serialize( + self, + admin_jobs_extract_data_and_load_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_jobs_extract_data_and_load_dto is not None: + _body_params = admin_jobs_extract_data_and_load_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/op/data/startExtractAndLoad', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def start_load( + self, + data_in_data_load_request: DataInDataLoadRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInDataLoadResponse: + """Start the data load for analytic tenants + + This API starts the data load process for all analytic tenants included in the specified data files uploaded to the Visier SFTP server. On success, you receive a job ID that can be filtered and searched for within the Jobs room in Visier. This job ID is associated with the receiving job, and related to all processing jobs that spawn for each analytic tenant. With the job ID, you can also call the next two APIs to retrieve the status of the receiving job and the status list of all related processing jobs. **Prerequisite:** You must first obtain Visier's public encryption key and upload the source data files to Visier's SFTP server. Files must have a .zip.gpg extension, meaning the files are encrypted using the PGP protocol and compressed. Visier provides SFTP server credentials and instructions. You can find the encryption key at https://www.visier.com/pgp/visier.public.pgp.asc. After downloading the file, open the file in a text editor or by dragging it into your browser. **Note:** - To see the full status of all analytic tenant data loads, navigate to the Jobs room in a project. - For performance and efficiency, Visier requires that the uncompressed batch file size is below 5 GB and that no more than 5000 tenants are included in a batch. + + :param data_in_data_load_request: (required) + :type data_in_data_load_request: DataInDataLoadRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_load_serialize( + data_in_data_load_request=data_in_data_load_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInDataLoadResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def start_load_with_http_info( + self, + data_in_data_load_request: DataInDataLoadRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInDataLoadResponse]: + """Start the data load for analytic tenants + + This API starts the data load process for all analytic tenants included in the specified data files uploaded to the Visier SFTP server. On success, you receive a job ID that can be filtered and searched for within the Jobs room in Visier. This job ID is associated with the receiving job, and related to all processing jobs that spawn for each analytic tenant. With the job ID, you can also call the next two APIs to retrieve the status of the receiving job and the status list of all related processing jobs. **Prerequisite:** You must first obtain Visier's public encryption key and upload the source data files to Visier's SFTP server. Files must have a .zip.gpg extension, meaning the files are encrypted using the PGP protocol and compressed. Visier provides SFTP server credentials and instructions. You can find the encryption key at https://www.visier.com/pgp/visier.public.pgp.asc. After downloading the file, open the file in a text editor or by dragging it into your browser. **Note:** - To see the full status of all analytic tenant data loads, navigate to the Jobs room in a project. - For performance and efficiency, Visier requires that the uncompressed batch file size is below 5 GB and that no more than 5000 tenants are included in a batch. + + :param data_in_data_load_request: (required) + :type data_in_data_load_request: DataInDataLoadRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_load_serialize( + data_in_data_load_request=data_in_data_load_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInDataLoadResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def start_load_without_preload_content( + self, + data_in_data_load_request: DataInDataLoadRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Start the data load for analytic tenants + + This API starts the data load process for all analytic tenants included in the specified data files uploaded to the Visier SFTP server. On success, you receive a job ID that can be filtered and searched for within the Jobs room in Visier. This job ID is associated with the receiving job, and related to all processing jobs that spawn for each analytic tenant. With the job ID, you can also call the next two APIs to retrieve the status of the receiving job and the status list of all related processing jobs. **Prerequisite:** You must first obtain Visier's public encryption key and upload the source data files to Visier's SFTP server. Files must have a .zip.gpg extension, meaning the files are encrypted using the PGP protocol and compressed. Visier provides SFTP server credentials and instructions. You can find the encryption key at https://www.visier.com/pgp/visier.public.pgp.asc. After downloading the file, open the file in a text editor or by dragging it into your browser. **Note:** - To see the full status of all analytic tenant data loads, navigate to the Jobs room in a project. - For performance and efficiency, Visier requires that the uncompressed batch file size is below 5 GB and that no more than 5000 tenants are included in a batch. + + :param data_in_data_load_request: (required) + :type data_in_data_load_request: DataInDataLoadRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_load_serialize( + data_in_data_load_request=data_in_data_load_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInDataLoadResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _start_load_serialize( + self, + data_in_data_load_request, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if data_in_data_load_request is not None: + _body_params = data_in_data_load_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/op/data/startload', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/data_intake_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/data_intake_api.py new file mode 100644 index 0000000000..f97a28cff1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/data_intake_api.py @@ -0,0 +1,1866 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBytes, StrictInt, StrictStr +from typing import Optional, Tuple, Union +from typing_extensions import Annotated +from visier_platform_sdk.models.data_in_push_data_cancel_response import DataInPushDataCancelResponse +from visier_platform_sdk.models.data_in_push_data_complete_request import DataInPushDataCompleteRequest +from visier_platform_sdk.models.data_in_push_data_complete_response import DataInPushDataCompleteResponse +from visier_platform_sdk.models.data_in_push_data_response import DataInPushDataResponse +from visier_platform_sdk.models.data_in_start_transfer_response import DataInStartTransferResponse +from visier_platform_sdk.models.designer_push_data_source_definitions_dto import DesignerPushDataSourceDefinitionsDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class DataIntakeApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def get_sources( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerPushDataSourceDefinitionsDTO: + """Retrieve a list of sources + + Prior to transferring data to Visier, you must identify the sources you want to target. Sources store data for the solution and are used to map data to Visier's data model. **Note:** To set up sources in your tenant, contact Visier Customer Success. This API allows you to query the list of available sources, and identify the source schema and required fields. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_sources_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerPushDataSourceDefinitionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_sources_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerPushDataSourceDefinitionsDTO]: + """Retrieve a list of sources + + Prior to transferring data to Visier, you must identify the sources you want to target. Sources store data for the solution and are used to map data to Visier's data model. **Note:** To set up sources in your tenant, contact Visier Customer Success. This API allows you to query the list of available sources, and identify the source schema and required fields. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_sources_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerPushDataSourceDefinitionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_sources_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of sources + + Prior to transferring data to Visier, you must identify the sources you want to target. Sources store data for the solution and are used to map data to Visier's data model. **Note:** To set up sources in your tenant, contact Visier Customer Success. This API allows you to query the list of available sources, and identify the source schema and required fields. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_sources_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerPushDataSourceDefinitionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_sources_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/data-sources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def push_data( + self, + transfer_session_id: Annotated[StrictStr, Field(description="The transfer session ID returned after the data transfer session starts.")], + body: StrictStr, + source_id: Annotated[Optional[StrictStr], Field(description="The unique identifier associated with the source you want to transfer data to.")] = None, + sequence: Annotated[Optional[StrictInt], Field(description="The unique sequence number associated with a batch of records.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInPushDataResponse: + """Transfer data to sources via JSON + + Transfer data to Visier in batches of records. Each request includes a batch of records formatted as a comma separated array with the first row containing the column headers in the request body. Each subsequent request should also include the first row as a header. Each request transfers a batch of records to a single source. Transfer sessions may include one or more batches before completion. Each batch is identified by a sequence number. Sequence numbers help identify any batches that were delivered incorrectly. Each batch is limited to the following request size: - Batch size limit: 10 MB - Record count limit: 300,000 rows + + :param transfer_session_id: The transfer session ID returned after the data transfer session starts. (required) + :type transfer_session_id: str + :param body: (required) + :type body: str + :param source_id: The unique identifier associated with the source you want to transfer data to. + :type source_id: str + :param sequence: The unique sequence number associated with a batch of records. + :type sequence: int + :param tenant_code: The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._push_data_serialize( + transfer_session_id=transfer_session_id, + body=body, + source_id=source_id, + sequence=sequence, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def push_data_with_http_info( + self, + transfer_session_id: Annotated[StrictStr, Field(description="The transfer session ID returned after the data transfer session starts.")], + body: StrictStr, + source_id: Annotated[Optional[StrictStr], Field(description="The unique identifier associated with the source you want to transfer data to.")] = None, + sequence: Annotated[Optional[StrictInt], Field(description="The unique sequence number associated with a batch of records.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInPushDataResponse]: + """Transfer data to sources via JSON + + Transfer data to Visier in batches of records. Each request includes a batch of records formatted as a comma separated array with the first row containing the column headers in the request body. Each subsequent request should also include the first row as a header. Each request transfers a batch of records to a single source. Transfer sessions may include one or more batches before completion. Each batch is identified by a sequence number. Sequence numbers help identify any batches that were delivered incorrectly. Each batch is limited to the following request size: - Batch size limit: 10 MB - Record count limit: 300,000 rows + + :param transfer_session_id: The transfer session ID returned after the data transfer session starts. (required) + :type transfer_session_id: str + :param body: (required) + :type body: str + :param source_id: The unique identifier associated with the source you want to transfer data to. + :type source_id: str + :param sequence: The unique sequence number associated with a batch of records. + :type sequence: int + :param tenant_code: The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._push_data_serialize( + transfer_session_id=transfer_session_id, + body=body, + source_id=source_id, + sequence=sequence, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def push_data_without_preload_content( + self, + transfer_session_id: Annotated[StrictStr, Field(description="The transfer session ID returned after the data transfer session starts.")], + body: StrictStr, + source_id: Annotated[Optional[StrictStr], Field(description="The unique identifier associated with the source you want to transfer data to.")] = None, + sequence: Annotated[Optional[StrictInt], Field(description="The unique sequence number associated with a batch of records.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Transfer data to sources via JSON + + Transfer data to Visier in batches of records. Each request includes a batch of records formatted as a comma separated array with the first row containing the column headers in the request body. Each subsequent request should also include the first row as a header. Each request transfers a batch of records to a single source. Transfer sessions may include one or more batches before completion. Each batch is identified by a sequence number. Sequence numbers help identify any batches that were delivered incorrectly. Each batch is limited to the following request size: - Batch size limit: 10 MB - Record count limit: 300,000 rows + + :param transfer_session_id: The transfer session ID returned after the data transfer session starts. (required) + :type transfer_session_id: str + :param body: (required) + :type body: str + :param source_id: The unique identifier associated with the source you want to transfer data to. + :type source_id: str + :param sequence: The unique sequence number associated with a batch of records. + :type sequence: int + :param tenant_code: The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._push_data_serialize( + transfer_session_id=transfer_session_id, + body=body, + source_id=source_id, + sequence=sequence, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _push_data_serialize( + self, + transfer_session_id, + body, + source_id, + sequence, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if transfer_session_id is not None: + _path_params['transferSessionId'] = transfer_session_id + # process the query parameters + if source_id is not None: + + _query_params.append(('sourceId', source_id)) + + if sequence is not None: + + _query_params.append(('sequence', sequence)) + + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/op/data-transfer-sessions/{transferSessionId}/add', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def push_data_cancel( + self, + transfer_session_id: Annotated[StrictStr, Field(description="The transfer session ID to cancel.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInPushDataCancelResponse: + """Cancel a transfer session + + Cancel a transfer session after starting it. If a transfer session is cancelled, all records within the transfer session do not persist in Visier's data store. If you cancel a transfer session, please start a new transfer session and resend the complete data set. You might cancel a transfer session if: - A request to send a batch of records failed. - The original set of records is incomplete. - An infrastructure error occurs. + + :param transfer_session_id: The transfer session ID to cancel. (required) + :type transfer_session_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._push_data_cancel_serialize( + transfer_session_id=transfer_session_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataCancelResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def push_data_cancel_with_http_info( + self, + transfer_session_id: Annotated[StrictStr, Field(description="The transfer session ID to cancel.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInPushDataCancelResponse]: + """Cancel a transfer session + + Cancel a transfer session after starting it. If a transfer session is cancelled, all records within the transfer session do not persist in Visier's data store. If you cancel a transfer session, please start a new transfer session and resend the complete data set. You might cancel a transfer session if: - A request to send a batch of records failed. - The original set of records is incomplete. - An infrastructure error occurs. + + :param transfer_session_id: The transfer session ID to cancel. (required) + :type transfer_session_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._push_data_cancel_serialize( + transfer_session_id=transfer_session_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataCancelResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def push_data_cancel_without_preload_content( + self, + transfer_session_id: Annotated[StrictStr, Field(description="The transfer session ID to cancel.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Cancel a transfer session + + Cancel a transfer session after starting it. If a transfer session is cancelled, all records within the transfer session do not persist in Visier's data store. If you cancel a transfer session, please start a new transfer session and resend the complete data set. You might cancel a transfer session if: - A request to send a batch of records failed. - The original set of records is incomplete. - An infrastructure error occurs. + + :param transfer_session_id: The transfer session ID to cancel. (required) + :type transfer_session_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._push_data_cancel_serialize( + transfer_session_id=transfer_session_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataCancelResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _push_data_cancel_serialize( + self, + transfer_session_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if transfer_session_id is not None: + _path_params['transferSessionId'] = transfer_session_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/op/data-transfer-sessions/{transferSessionId}/cancel', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def push_data_complete( + self, + data_in_push_data_complete_request: DataInPushDataCompleteRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInPushDataCompleteResponse: + """Complete a transfer session + + Complete the specified transfer session by triggering a receiving job. A receiving job validates the transferred data and adds the transferred data to Visier's data store. You can set an optional parameter to generate a data version through a processing job immediately after the receiving job completes. + + :param data_in_push_data_complete_request: (required) + :type data_in_push_data_complete_request: DataInPushDataCompleteRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._push_data_complete_serialize( + data_in_push_data_complete_request=data_in_push_data_complete_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataCompleteResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def push_data_complete_with_http_info( + self, + data_in_push_data_complete_request: DataInPushDataCompleteRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInPushDataCompleteResponse]: + """Complete a transfer session + + Complete the specified transfer session by triggering a receiving job. A receiving job validates the transferred data and adds the transferred data to Visier's data store. You can set an optional parameter to generate a data version through a processing job immediately after the receiving job completes. + + :param data_in_push_data_complete_request: (required) + :type data_in_push_data_complete_request: DataInPushDataCompleteRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._push_data_complete_serialize( + data_in_push_data_complete_request=data_in_push_data_complete_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataCompleteResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def push_data_complete_without_preload_content( + self, + data_in_push_data_complete_request: DataInPushDataCompleteRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Complete a transfer session + + Complete the specified transfer session by triggering a receiving job. A receiving job validates the transferred data and adds the transferred data to Visier's data store. You can set an optional parameter to generate a data version through a processing job immediately after the receiving job completes. + + :param data_in_push_data_complete_request: (required) + :type data_in_push_data_complete_request: DataInPushDataCompleteRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._push_data_complete_serialize( + data_in_push_data_complete_request=data_in_push_data_complete_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataCompleteResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _push_data_complete_serialize( + self, + data_in_push_data_complete_request, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if data_in_push_data_complete_request is not None: + _body_params = data_in_push_data_complete_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/op/jobs/receiving-jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def start_transfer( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInStartTransferResponse: + """Start a transfer session + + Start a new transfer session. A transfer session can include one or more batches of records to be sent to Visier. Batches of records may be transferred as JSON or file payloads. Recommended: For optimal performance, please include all batches of records in a single transfer session. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_transfer_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInStartTransferResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def start_transfer_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInStartTransferResponse]: + """Start a transfer session + + Start a new transfer session. A transfer session can include one or more batches of records to be sent to Visier. Batches of records may be transferred as JSON or file payloads. Recommended: For optimal performance, please include all batches of records in a single transfer session. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_transfer_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInStartTransferResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def start_transfer_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Start a transfer session + + Start a new transfer session. A transfer session can include one or more batches of records to be sent to Visier. Batches of records may be transferred as JSON or file payloads. Recommended: For optimal performance, please include all batches of records in a single transfer session. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_transfer_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInStartTransferResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _start_transfer_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/op/data-transfer-sessions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def upload_data( + self, + transfer_session_id: Annotated[StrictStr, Field(description="The transfer session ID returned after the data transfer session starts.")], + source_id: Annotated[Optional[StrictStr], Field(description="The unique identifier associated with the source you want to transfer data to.")] = None, + sequence: Annotated[Optional[StrictStr], Field(description="The unique sequence number associated with a batch of records.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o.")] = None, + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to upload in CSV or ZIP format.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataInPushDataResponse: + """Transfer data to sources via file upload + + Upload data to Visier as CSV or ZIP files. Each request transfers a single file. If the data intended for Visier is stored in multiple files, you may compress them into a single ZIP file or make multiple requests within the same transfer session. File size limit: 3 GB Each file is identified by a sequence number. Sequence numbers help identify any batches that were delivered incorrectly. If you define a specific source in the request, all files within the request will target the declared source. If a source is not defined, the filenames are matched against the source regex to correctly assign each file to a source. To find out the source regex, please contact Visier Customer Success. **Note:** If you include files that should target multiple sources in one ZIP file, do not define a source in the request. Analytic tenants: For optimal transfer speed, provide one ZIP file per source. Administrating tenants: For optimal transfer speed, provide one ZIP file containing all the required data files for your analytic tenants. In the ZIP file, use one folder per analytic tenant. The ZIP file must adhere to the following file structure: File1.zip - Folder1: WFF_tenantCode1 - Filename1.csv - Filename2.csv - Folder2: WFF_tenantCode2 - Filename3.csv - Filename4.csv + + :param transfer_session_id: The transfer session ID returned after the data transfer session starts. (required) + :type transfer_session_id: str + :param source_id: The unique identifier associated with the source you want to transfer data to. + :type source_id: str + :param sequence: The unique sequence number associated with a batch of records. + :type sequence: str + :param tenant_code: The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param file: The file to upload in CSV or ZIP format. + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upload_data_serialize( + transfer_session_id=transfer_session_id, + source_id=source_id, + sequence=sequence, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def upload_data_with_http_info( + self, + transfer_session_id: Annotated[StrictStr, Field(description="The transfer session ID returned after the data transfer session starts.")], + source_id: Annotated[Optional[StrictStr], Field(description="The unique identifier associated with the source you want to transfer data to.")] = None, + sequence: Annotated[Optional[StrictStr], Field(description="The unique sequence number associated with a batch of records.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o.")] = None, + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to upload in CSV or ZIP format.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataInPushDataResponse]: + """Transfer data to sources via file upload + + Upload data to Visier as CSV or ZIP files. Each request transfers a single file. If the data intended for Visier is stored in multiple files, you may compress them into a single ZIP file or make multiple requests within the same transfer session. File size limit: 3 GB Each file is identified by a sequence number. Sequence numbers help identify any batches that were delivered incorrectly. If you define a specific source in the request, all files within the request will target the declared source. If a source is not defined, the filenames are matched against the source regex to correctly assign each file to a source. To find out the source regex, please contact Visier Customer Success. **Note:** If you include files that should target multiple sources in one ZIP file, do not define a source in the request. Analytic tenants: For optimal transfer speed, provide one ZIP file per source. Administrating tenants: For optimal transfer speed, provide one ZIP file containing all the required data files for your analytic tenants. In the ZIP file, use one folder per analytic tenant. The ZIP file must adhere to the following file structure: File1.zip - Folder1: WFF_tenantCode1 - Filename1.csv - Filename2.csv - Folder2: WFF_tenantCode2 - Filename3.csv - Filename4.csv + + :param transfer_session_id: The transfer session ID returned after the data transfer session starts. (required) + :type transfer_session_id: str + :param source_id: The unique identifier associated with the source you want to transfer data to. + :type source_id: str + :param sequence: The unique sequence number associated with a batch of records. + :type sequence: str + :param tenant_code: The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param file: The file to upload in CSV or ZIP format. + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upload_data_serialize( + transfer_session_id=transfer_session_id, + source_id=source_id, + sequence=sequence, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def upload_data_without_preload_content( + self, + transfer_session_id: Annotated[StrictStr, Field(description="The transfer session ID returned after the data transfer session starts.")], + source_id: Annotated[Optional[StrictStr], Field(description="The unique identifier associated with the source you want to transfer data to.")] = None, + sequence: Annotated[Optional[StrictStr], Field(description="The unique sequence number associated with a batch of records.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o.")] = None, + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to upload in CSV or ZIP format.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Transfer data to sources via file upload + + Upload data to Visier as CSV or ZIP files. Each request transfers a single file. If the data intended for Visier is stored in multiple files, you may compress them into a single ZIP file or make multiple requests within the same transfer session. File size limit: 3 GB Each file is identified by a sequence number. Sequence numbers help identify any batches that were delivered incorrectly. If you define a specific source in the request, all files within the request will target the declared source. If a source is not defined, the filenames are matched against the source regex to correctly assign each file to a source. To find out the source regex, please contact Visier Customer Success. **Note:** If you include files that should target multiple sources in one ZIP file, do not define a source in the request. Analytic tenants: For optimal transfer speed, provide one ZIP file per source. Administrating tenants: For optimal transfer speed, provide one ZIP file containing all the required data files for your analytic tenants. In the ZIP file, use one folder per analytic tenant. The ZIP file must adhere to the following file structure: File1.zip - Folder1: WFF_tenantCode1 - Filename1.csv - Filename2.csv - Folder2: WFF_tenantCode2 - Filename3.csv - Filename4.csv + + :param transfer_session_id: The transfer session ID returned after the data transfer session starts. (required) + :type transfer_session_id: str + :param source_id: The unique identifier associated with the source you want to transfer data to. + :type source_id: str + :param sequence: The unique sequence number associated with a batch of records. + :type sequence: str + :param tenant_code: The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param file: The file to upload in CSV or ZIP format. + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upload_data_serialize( + transfer_session_id=transfer_session_id, + source_id=source_id, + sequence=sequence, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataInPushDataResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _upload_data_serialize( + self, + transfer_session_id, + source_id, + sequence, + tenant_code, + target_tenant_id, + file, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if transfer_session_id is not None: + _path_params['transferSessionId'] = transfer_session_id + # process the query parameters + if source_id is not None: + + _query_params.append(('sourceId', source_id)) + + if sequence is not None: + + _query_params.append(('sequence', sequence)) + + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + if file is not None: + _files['file'] = file + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/op/data-transfer-sessions/{transferSessionId}/upload', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/data_model_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/data_model_api.py new file mode 100644 index 0000000000..040e85c330 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/data_model_api.py @@ -0,0 +1,13164 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr +from typing import List, Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.dataservices_datamodel_analytic_object_dto import DataservicesDatamodelAnalyticObjectDTO +from visier_platform_sdk.models.dataservices_datamodel_analytic_objects_dto import DataservicesDatamodelAnalyticObjectsDTO +from visier_platform_sdk.models.dataservices_datamodel_currencies_dto import DataservicesDatamodelCurrenciesDTO +from visier_platform_sdk.models.dataservices_datamodel_currency_dto import DataservicesDatamodelCurrencyDTO +from visier_platform_sdk.models.dataservices_datamodel_currency_rates_dto import DataservicesDatamodelCurrencyRatesDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_dto import DataservicesDatamodelDimensionDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_mapping_validation_dto import DataservicesDatamodelDimensionMappingValidationDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_mapping_validation_execution_dto import DataservicesDatamodelDimensionMappingValidationExecutionDTO +from visier_platform_sdk.models.dataservices_datamodel_dimensions_dto import DataservicesDatamodelDimensionsDTO +from visier_platform_sdk.models.dataservices_datamodel_members_dto import DataservicesDatamodelMembersDTO +from visier_platform_sdk.models.dataservices_datamodel_metric_dto import DataservicesDatamodelMetricDTO +from visier_platform_sdk.models.dataservices_datamodel_metrics_dto import DataservicesDatamodelMetricsDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_model_dto import DataservicesDatamodelPlanningModelDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_models_dto import DataservicesDatamodelPlanningModelsDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_plan_dto import DataservicesDatamodelPlanningPlanDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_plans_dto import DataservicesDatamodelPlanningPlansDTO +from visier_platform_sdk.models.dataservices_datamodel_prediction_dto import DataservicesDatamodelPredictionDTO +from visier_platform_sdk.models.dataservices_datamodel_predictions_dto import DataservicesDatamodelPredictionsDTO +from visier_platform_sdk.models.dataservices_datamodel_properties_dto import DataservicesDatamodelPropertiesDTO +from visier_platform_sdk.models.dataservices_datamodel_property_dto import DataservicesDatamodelPropertyDTO +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_dto import DataservicesDatamodelSelectionConceptDTO +from visier_platform_sdk.models.dataservices_datamodel_selection_concepts_dto import DataservicesDatamodelSelectionConceptsDTO +from visier_platform_sdk.models.planning_get_plan_list_response_dto import PlanningGetPlanListResponseDTO +from visier_platform_sdk.models.planning_plan_with_schema_dto import PlanningPlanWithSchemaDTO +from visier_platform_sdk.models.servicing_objectconfiguration_dimensions_change_definitions_dto import ServicingObjectconfigurationDimensionsChangeDefinitionsDTO +from visier_platform_sdk.models.servicing_objectconfiguration_objects_bulk_change_response_dto import ServicingObjectconfigurationObjectsBulkChangeResponseDTO +from visier_platform_sdk.models.servicing_objectconfiguration_properties_change_definitions_dto import ServicingObjectconfigurationPropertiesChangeDefinitionsDTO +from visier_platform_sdk.models.servicing_objectconfiguration_properties_delete_definitions_dto import ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_bulk_delete_response_dto import ServicingObjectconfigurationPropertyBulkDeleteResponseDTO +from visier_platform_sdk.models.servicing_question_categories_api_response_dto import ServicingQuestionCategoriesAPIResponseDTO +from visier_platform_sdk.models.servicing_question_category_api_response_dto import ServicingQuestionCategoryAPIResponseDTO +from visier_platform_sdk.models.servicing_sample_question_api_response_dto import ServicingSampleQuestionAPIResponseDTO +from visier_platform_sdk.models.servicing_sample_questions_api_response_dto import ServicingSampleQuestionsAPIResponseDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_request_dto import ServicingV2ObjectconfigurationAnalyticObjectRequestDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_bulk_change_response_dto import ServicingV2ObjectconfigurationBulkChangeResponseDTO +from visier_platform_sdk.models.servicing_vee_questions_bulk_change_response_dto import ServicingVeeQuestionsBulkChangeResponseDTO +from visier_platform_sdk.models.servicing_vee_questions_change_definitions_dto import ServicingVeeQuestionsChangeDefinitionsDTO +from visier_platform_sdk.models.servicing_vee_questions_delete_definitions_dto import ServicingVeeQuestionsDeleteDefinitionsDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class DataModelApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def analytic_metrics( + self, + id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve metrics for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelMetricsDTO: + """Retrieve a list of metrics for an analytic object by ID + + If you know the ID of an analytic object, use this API to retrieve metrics for that object specifically. + + :param id: The ID of the analytic object to retrieve metrics for. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._analytic_metrics_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def analytic_metrics_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve metrics for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelMetricsDTO]: + """Retrieve a list of metrics for an analytic object by ID + + If you know the ID of an analytic object, use this API to retrieve metrics for that object specifically. + + :param id: The ID of the analytic object to retrieve metrics for. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._analytic_metrics_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def analytic_metrics_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve metrics for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of metrics for an analytic object by ID + + If you know the ID of an analytic object, use this API to retrieve metrics for that object specifically. + + :param id: The ID of the analytic object to retrieve metrics for. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._analytic_metrics_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _analytic_metrics_serialize( + self, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects/{id}/metrics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def analytic_object( + self, + id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelAnalyticObjectDTO: + """Retrieve an analytic object by ID + + If you know the ID of an analytic object, use this API to retrieve that object specifically. + + :param id: The ID of the analytic object to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._analytic_object_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelAnalyticObjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def analytic_object_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelAnalyticObjectDTO]: + """Retrieve an analytic object by ID + + If you know the ID of an analytic object, use this API to retrieve that object specifically. + + :param id: The ID of the analytic object to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._analytic_object_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelAnalyticObjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def analytic_object_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an analytic object by ID + + If you know the ID of an analytic object, use this API to retrieve that object specifically. + + :param id: The ID of the analytic object to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._analytic_object_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelAnalyticObjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _analytic_object_serialize( + self, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def analytic_objects( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the analytic objects to retrieve. Default is all analytic objects.")] = None, + object_type: Annotated[Optional[StrictStr], Field(description="The object type to filter the returned analytic objects by.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelAnalyticObjectsDTO: + """Retrieve a list of analytic objects + + Retrieve all the analytic objects in your Visier solution. + + :param id: The IDs of the analytic objects to retrieve. Default is all analytic objects. + :type id: List[str] + :param object_type: The object type to filter the returned analytic objects by. + :type object_type: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._analytic_objects_serialize( + id=id, + object_type=object_type, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelAnalyticObjectsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def analytic_objects_with_http_info( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the analytic objects to retrieve. Default is all analytic objects.")] = None, + object_type: Annotated[Optional[StrictStr], Field(description="The object type to filter the returned analytic objects by.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelAnalyticObjectsDTO]: + """Retrieve a list of analytic objects + + Retrieve all the analytic objects in your Visier solution. + + :param id: The IDs of the analytic objects to retrieve. Default is all analytic objects. + :type id: List[str] + :param object_type: The object type to filter the returned analytic objects by. + :type object_type: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._analytic_objects_serialize( + id=id, + object_type=object_type, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelAnalyticObjectsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def analytic_objects_without_preload_content( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the analytic objects to retrieve. Default is all analytic objects.")] = None, + object_type: Annotated[Optional[StrictStr], Field(description="The object type to filter the returned analytic objects by.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of analytic objects + + Retrieve all the analytic objects in your Visier solution. + + :param id: The IDs of the analytic objects to retrieve. Default is all analytic objects. + :type id: List[str] + :param object_type: The object type to filter the returned analytic objects by. + :type object_type: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._analytic_objects_serialize( + id=id, + object_type=object_type, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelAnalyticObjectsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _analytic_objects_serialize( + self, + id, + object_type, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + if object_type is not None: + + _query_params.append(('objectType', object_type)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def call_property( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[List[StrictStr], Field(description="The ID of the property to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelPropertyDTO: + """Retrieve a property by ID + + If you know the ID of a property, use this API to retrieve that property specifically. You must also know the analytic object's ID.. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The ID of the property to retrieve. (required) + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._call_property_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPropertyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def call_property_with_http_info( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[List[StrictStr], Field(description="The ID of the property to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelPropertyDTO]: + """Retrieve a property by ID + + If you know the ID of a property, use this API to retrieve that property specifically. You must also know the analytic object's ID.. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The ID of the property to retrieve. (required) + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._call_property_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPropertyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def call_property_without_preload_content( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[List[StrictStr], Field(description="The ID of the property to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a property by ID + + If you know the ID of a property, use this API to retrieve that property specifically. You must also know the analytic object's ID.. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The ID of the property to retrieve. (required) + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._call_property_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPropertyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _call_property_serialize( + self, + object_id, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'csv', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if object_id is not None: + _path_params['objectId'] = object_id + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects/{objectId}/properties/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_properties( + self, + servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingObjectconfigurationObjectsBulkChangeResponseDTO: + """Create properties + + Create new properties. Administrating tenant users can specify the tenant in which to add these properties. + + :param servicing_objectconfiguration_properties_change_definitions_dto: (required) + :type servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_properties_serialize( + servicing_objectconfiguration_properties_change_definitions_dto=servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_properties_with_http_info( + self, + servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingObjectconfigurationObjectsBulkChangeResponseDTO]: + """Create properties + + Create new properties. Administrating tenant users can specify the tenant in which to add these properties. + + :param servicing_objectconfiguration_properties_change_definitions_dto: (required) + :type servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_properties_serialize( + servicing_objectconfiguration_properties_change_definitions_dto=servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_properties_without_preload_content( + self, + servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create properties + + Create new properties. Administrating tenant users can specify the tenant in which to add these properties. + + :param servicing_objectconfiguration_properties_change_definitions_dto: (required) + :type servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_properties_serialize( + servicing_objectconfiguration_properties_change_definitions_dto=servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_properties_serialize( + self, + servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_objectconfiguration_properties_change_definitions_dto is not None: + _body_params = servicing_objectconfiguration_properties_change_definitions_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/data/model/properties', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_vee_sample_questions( + self, + servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingVeeQuestionsBulkChangeResponseDTO: + """Add Vee sample questions + + Create new sample questions that your users can ask Vee. Administrating tenants can specify the tenant in which to add sample questions using the `TargetTenantID` header.
**Note:** 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). + + :param servicing_vee_questions_change_definitions_dto: (required) + :type servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_vee_sample_questions_serialize( + servicing_vee_questions_change_definitions_dto=servicing_vee_questions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_vee_sample_questions_with_http_info( + self, + servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingVeeQuestionsBulkChangeResponseDTO]: + """Add Vee sample questions + + Create new sample questions that your users can ask Vee. Administrating tenants can specify the tenant in which to add sample questions using the `TargetTenantID` header.
**Note:** 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). + + :param servicing_vee_questions_change_definitions_dto: (required) + :type servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_vee_sample_questions_serialize( + servicing_vee_questions_change_definitions_dto=servicing_vee_questions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_vee_sample_questions_without_preload_content( + self, + servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add Vee sample questions + + Create new sample questions that your users can ask Vee. Administrating tenants can specify the tenant in which to add sample questions using the `TargetTenantID` header.
**Note:** 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). + + :param servicing_vee_questions_change_definitions_dto: (required) + :type servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_vee_sample_questions_serialize( + servicing_vee_questions_change_definitions_dto=servicing_vee_questions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_vee_sample_questions_serialize( + self, + servicing_vee_questions_change_definitions_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_vee_questions_change_definitions_dto is not None: + _body_params = servicing_vee_questions_change_definitions_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/data/model/vee/sample-questions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def currencies( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelCurrenciesDTO: + """Retrieve all currencies + + Retrieve all the available currencies in your Visier solution. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currencies_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrenciesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def currencies_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelCurrenciesDTO]: + """Retrieve all currencies + + Retrieve all the available currencies in your Visier solution. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currencies_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrenciesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def currencies_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve all currencies + + Retrieve all the available currencies in your Visier solution. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currencies_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrenciesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _currencies_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/currencies', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def currency( + self, + id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelCurrencyDTO: + """Retrieve a currency + + Retrieve a specific currency if you know the currency code. + + :param id: The ISO 4217 3-letter code for the currency. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currency_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrencyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def currency_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelCurrencyDTO]: + """Retrieve a currency + + Retrieve a specific currency if you know the currency code. + + :param id: The ISO 4217 3-letter code for the currency. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currency_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrencyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def currency_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a currency + + Retrieve a specific currency if you know the currency code. + + :param id: The ISO 4217 3-letter code for the currency. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currency_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrencyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _currency_serialize( + self, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/currencies/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def currency_rates( + self, + id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency to get rates for.")], + start_time: Annotated[Optional[StrictStr], Field(description="The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds.")] = None, + decimals: Annotated[Optional[StrictStr], Field(description="The number of decimals to round exchange rates to. Default is to round to 2 decimal places.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelCurrencyRatesDTO: + """Retrieve all exchange rates for a currency + + Retrieve exchange rates for a specific currency from Visier. You can optionally specify query parameter options for the returned rates, such as the number of decimals to round the exchange rate to. + + :param id: The ISO 4217 3-letter code for the currency to get rates for. (required) + :type id: str + :param start_time: The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds. + :type start_time: str + :param end_time: The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds. + :type end_time: str + :param decimals: The number of decimals to round exchange rates to. Default is to round to 2 decimal places. + :type decimals: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currency_rates_serialize( + id=id, + start_time=start_time, + end_time=end_time, + decimals=decimals, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrencyRatesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def currency_rates_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency to get rates for.")], + start_time: Annotated[Optional[StrictStr], Field(description="The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds.")] = None, + decimals: Annotated[Optional[StrictStr], Field(description="The number of decimals to round exchange rates to. Default is to round to 2 decimal places.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelCurrencyRatesDTO]: + """Retrieve all exchange rates for a currency + + Retrieve exchange rates for a specific currency from Visier. You can optionally specify query parameter options for the returned rates, such as the number of decimals to round the exchange rate to. + + :param id: The ISO 4217 3-letter code for the currency to get rates for. (required) + :type id: str + :param start_time: The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds. + :type start_time: str + :param end_time: The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds. + :type end_time: str + :param decimals: The number of decimals to round exchange rates to. Default is to round to 2 decimal places. + :type decimals: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currency_rates_serialize( + id=id, + start_time=start_time, + end_time=end_time, + decimals=decimals, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrencyRatesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def currency_rates_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency to get rates for.")], + start_time: Annotated[Optional[StrictStr], Field(description="The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds.")] = None, + decimals: Annotated[Optional[StrictStr], Field(description="The number of decimals to round exchange rates to. Default is to round to 2 decimal places.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve all exchange rates for a currency + + Retrieve exchange rates for a specific currency from Visier. You can optionally specify query parameter options for the returned rates, such as the number of decimals to round the exchange rate to. + + :param id: The ISO 4217 3-letter code for the currency to get rates for. (required) + :type id: str + :param start_time: The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds. + :type start_time: str + :param end_time: The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds. + :type end_time: str + :param decimals: The number of decimals to round exchange rates to. Default is to round to 2 decimal places. + :type decimals: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currency_rates_serialize( + id=id, + start_time=start_time, + end_time=end_time, + decimals=decimals, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrencyRatesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _currency_rates_serialize( + self, + id, + start_time, + end_time, + decimals, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if start_time is not None: + + _query_params.append(('startTime', start_time)) + + if end_time is not None: + + _query_params.append(('endTime', end_time)) + + if decimals is not None: + + _query_params.append(('decimals', decimals)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/currencies/{id}/rates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def currency_rates_with_to_currency( + self, + id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency to convert from.")], + to_id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency to convert to.")], + start_time: Annotated[Optional[StrictStr], Field(description="The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds.")] = None, + decimals: Annotated[Optional[StrictStr], Field(description="The number of decimals to round exchange rates to. Default is to round to 2 decimal places.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelCurrencyRatesDTO: + """Retrieve exchange rates from one currency to another currency + + Retrieve exchange rates from a specific currency to another specific currency. You can optionally specify query parameter options for the returned rates, such as the number of decimals to round the exchange rate to. + + :param id: The ISO 4217 3-letter code for the currency to convert from. (required) + :type id: str + :param to_id: The ISO 4217 3-letter code for the currency to convert to. (required) + :type to_id: str + :param start_time: The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds. + :type start_time: str + :param end_time: The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds. + :type end_time: str + :param decimals: The number of decimals to round exchange rates to. Default is to round to 2 decimal places. + :type decimals: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currency_rates_with_to_currency_serialize( + id=id, + to_id=to_id, + start_time=start_time, + end_time=end_time, + decimals=decimals, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrencyRatesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def currency_rates_with_to_currency_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency to convert from.")], + to_id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency to convert to.")], + start_time: Annotated[Optional[StrictStr], Field(description="The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds.")] = None, + decimals: Annotated[Optional[StrictStr], Field(description="The number of decimals to round exchange rates to. Default is to round to 2 decimal places.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelCurrencyRatesDTO]: + """Retrieve exchange rates from one currency to another currency + + Retrieve exchange rates from a specific currency to another specific currency. You can optionally specify query parameter options for the returned rates, such as the number of decimals to round the exchange rate to. + + :param id: The ISO 4217 3-letter code for the currency to convert from. (required) + :type id: str + :param to_id: The ISO 4217 3-letter code for the currency to convert to. (required) + :type to_id: str + :param start_time: The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds. + :type start_time: str + :param end_time: The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds. + :type end_time: str + :param decimals: The number of decimals to round exchange rates to. Default is to round to 2 decimal places. + :type decimals: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currency_rates_with_to_currency_serialize( + id=id, + to_id=to_id, + start_time=start_time, + end_time=end_time, + decimals=decimals, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrencyRatesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def currency_rates_with_to_currency_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency to convert from.")], + to_id: Annotated[StrictStr, Field(description="The ISO 4217 3-letter code for the currency to convert to.")], + start_time: Annotated[Optional[StrictStr], Field(description="The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds.")] = None, + decimals: Annotated[Optional[StrictStr], Field(description="The number of decimals to round exchange rates to. Default is to round to 2 decimal places.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve exchange rates from one currency to another currency + + Retrieve exchange rates from a specific currency to another specific currency. You can optionally specify query parameter options for the returned rates, such as the number of decimals to round the exchange rate to. + + :param id: The ISO 4217 3-letter code for the currency to convert from. (required) + :type id: str + :param to_id: The ISO 4217 3-letter code for the currency to convert to. (required) + :type to_id: str + :param start_time: The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds. + :type start_time: str + :param end_time: The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds. + :type end_time: str + :param decimals: The number of decimals to round exchange rates to. Default is to round to 2 decimal places. + :type decimals: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._currency_rates_with_to_currency_serialize( + id=id, + to_id=to_id, + start_time=start_time, + end_time=end_time, + decimals=decimals, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelCurrencyRatesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _currency_rates_with_to_currency_serialize( + self, + id, + to_id, + start_time, + end_time, + decimals, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + if to_id is not None: + _path_params['toId'] = to_id + # process the query parameters + if start_time is not None: + + _query_params.append(('startTime', start_time)) + + if end_time is not None: + + _query_params.append(('endTime', end_time)) + + if decimals is not None: + + _query_params.append(('decimals', decimals)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/currencies/{id}/rates/{toId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_properties( + self, + servicing_objectconfiguration_properties_delete_definitions_dto: ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingObjectconfigurationPropertyBulkDeleteResponseDTO: + """Delete properties + + Delete existing properties. Administrating tenant users can specify the tenant in which to delete the properties. In each API request, delete up to 10 properties per tenant with a maximum of 500 tenants. + + :param servicing_objectconfiguration_properties_delete_definitions_dto: (required) + :type servicing_objectconfiguration_properties_delete_definitions_dto: ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_properties_serialize( + servicing_objectconfiguration_properties_delete_definitions_dto=servicing_objectconfiguration_properties_delete_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationPropertyBulkDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_properties_with_http_info( + self, + servicing_objectconfiguration_properties_delete_definitions_dto: ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingObjectconfigurationPropertyBulkDeleteResponseDTO]: + """Delete properties + + Delete existing properties. Administrating tenant users can specify the tenant in which to delete the properties. In each API request, delete up to 10 properties per tenant with a maximum of 500 tenants. + + :param servicing_objectconfiguration_properties_delete_definitions_dto: (required) + :type servicing_objectconfiguration_properties_delete_definitions_dto: ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_properties_serialize( + servicing_objectconfiguration_properties_delete_definitions_dto=servicing_objectconfiguration_properties_delete_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationPropertyBulkDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_properties_without_preload_content( + self, + servicing_objectconfiguration_properties_delete_definitions_dto: ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete properties + + Delete existing properties. Administrating tenant users can specify the tenant in which to delete the properties. In each API request, delete up to 10 properties per tenant with a maximum of 500 tenants. + + :param servicing_objectconfiguration_properties_delete_definitions_dto: (required) + :type servicing_objectconfiguration_properties_delete_definitions_dto: ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_properties_serialize( + servicing_objectconfiguration_properties_delete_definitions_dto=servicing_objectconfiguration_properties_delete_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationPropertyBulkDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_properties_serialize( + self, + servicing_objectconfiguration_properties_delete_definitions_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_objectconfiguration_properties_delete_definitions_dto is not None: + _body_params = servicing_objectconfiguration_properties_delete_definitions_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/data/model/properties', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_vee_sample_questions( + self, + servicing_vee_questions_delete_definitions_dto: ServicingVeeQuestionsDeleteDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingVeeQuestionsBulkChangeResponseDTO: + """Delete Vee sample questions + + Delete existing sample questions. Administrating tenants can specify the tenant in which to delete questions using the `TargetTenantID` header.
**Note:** 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). + + :param servicing_vee_questions_delete_definitions_dto: (required) + :type servicing_vee_questions_delete_definitions_dto: ServicingVeeQuestionsDeleteDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_vee_sample_questions_serialize( + servicing_vee_questions_delete_definitions_dto=servicing_vee_questions_delete_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_vee_sample_questions_with_http_info( + self, + servicing_vee_questions_delete_definitions_dto: ServicingVeeQuestionsDeleteDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingVeeQuestionsBulkChangeResponseDTO]: + """Delete Vee sample questions + + Delete existing sample questions. Administrating tenants can specify the tenant in which to delete questions using the `TargetTenantID` header.
**Note:** 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). + + :param servicing_vee_questions_delete_definitions_dto: (required) + :type servicing_vee_questions_delete_definitions_dto: ServicingVeeQuestionsDeleteDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_vee_sample_questions_serialize( + servicing_vee_questions_delete_definitions_dto=servicing_vee_questions_delete_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_vee_sample_questions_without_preload_content( + self, + servicing_vee_questions_delete_definitions_dto: ServicingVeeQuestionsDeleteDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Vee sample questions + + Delete existing sample questions. Administrating tenants can specify the tenant in which to delete questions using the `TargetTenantID` header.
**Note:** 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). + + :param servicing_vee_questions_delete_definitions_dto: (required) + :type servicing_vee_questions_delete_definitions_dto: ServicingVeeQuestionsDeleteDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_vee_sample_questions_serialize( + servicing_vee_questions_delete_definitions_dto=servicing_vee_questions_delete_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_vee_sample_questions_serialize( + self, + servicing_vee_questions_delete_definitions_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_vee_questions_delete_definitions_dto is not None: + _body_params = servicing_vee_questions_delete_definitions_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1alpha/data/model/vee/sample-questions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def dimension( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[StrictStr, Field(description="The ID of the dimension to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelDimensionDTO: + """Retrieve a dimension by ID + + If you know the ID of a dimension, use this API to retrieve that dimension specifically. You must also know the analytic object's ID. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The ID of the dimension to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dimension_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def dimension_with_http_info( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[StrictStr, Field(description="The ID of the dimension to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelDimensionDTO]: + """Retrieve a dimension by ID + + If you know the ID of a dimension, use this API to retrieve that dimension specifically. You must also know the analytic object's ID. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The ID of the dimension to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dimension_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def dimension_without_preload_content( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[StrictStr, Field(description="The ID of the dimension to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a dimension by ID + + If you know the ID of a dimension, use this API to retrieve that dimension specifically. You must also know the analytic object's ID. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The ID of the dimension to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dimension_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _dimension_serialize( + self, + object_id, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if object_id is not None: + _path_params['objectId'] = object_id + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects/{objectId}/dimensions/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def dimension_member_map_validation( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object.")], + dimension_id: Annotated[StrictStr, Field(description="The ID of a dimension of the member map.")], + dataservices_datamodel_dimension_mapping_validation_execution_dto: DataservicesDatamodelDimensionMappingValidationExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelDimensionMappingValidationDTO: + """Validate a member map's unmapped dimension members by ID + + If you know the ID of a member map, use this API to validate one of the member map's dimensions. You must also know the dimension's ID and the analytic object's ID. The response returns the member map ID, the requested dimension ID, a list of the dimension's unmapped members, and a list of errors found. + + :param object_id: The ID of the analytic object. (required) + :type object_id: str + :param dimension_id: The ID of a dimension of the member map. (required) + :type dimension_id: str + :param dataservices_datamodel_dimension_mapping_validation_execution_dto: (required) + :type dataservices_datamodel_dimension_mapping_validation_execution_dto: DataservicesDatamodelDimensionMappingValidationExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dimension_member_map_validation_serialize( + object_id=object_id, + dimension_id=dimension_id, + dataservices_datamodel_dimension_mapping_validation_execution_dto=dataservices_datamodel_dimension_mapping_validation_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionMappingValidationDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def dimension_member_map_validation_with_http_info( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object.")], + dimension_id: Annotated[StrictStr, Field(description="The ID of a dimension of the member map.")], + dataservices_datamodel_dimension_mapping_validation_execution_dto: DataservicesDatamodelDimensionMappingValidationExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelDimensionMappingValidationDTO]: + """Validate a member map's unmapped dimension members by ID + + If you know the ID of a member map, use this API to validate one of the member map's dimensions. You must also know the dimension's ID and the analytic object's ID. The response returns the member map ID, the requested dimension ID, a list of the dimension's unmapped members, and a list of errors found. + + :param object_id: The ID of the analytic object. (required) + :type object_id: str + :param dimension_id: The ID of a dimension of the member map. (required) + :type dimension_id: str + :param dataservices_datamodel_dimension_mapping_validation_execution_dto: (required) + :type dataservices_datamodel_dimension_mapping_validation_execution_dto: DataservicesDatamodelDimensionMappingValidationExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dimension_member_map_validation_serialize( + object_id=object_id, + dimension_id=dimension_id, + dataservices_datamodel_dimension_mapping_validation_execution_dto=dataservices_datamodel_dimension_mapping_validation_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionMappingValidationDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def dimension_member_map_validation_without_preload_content( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object.")], + dimension_id: Annotated[StrictStr, Field(description="The ID of a dimension of the member map.")], + dataservices_datamodel_dimension_mapping_validation_execution_dto: DataservicesDatamodelDimensionMappingValidationExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Validate a member map's unmapped dimension members by ID + + If you know the ID of a member map, use this API to validate one of the member map's dimensions. You must also know the dimension's ID and the analytic object's ID. The response returns the member map ID, the requested dimension ID, a list of the dimension's unmapped members, and a list of errors found. + + :param object_id: The ID of the analytic object. (required) + :type object_id: str + :param dimension_id: The ID of a dimension of the member map. (required) + :type dimension_id: str + :param dataservices_datamodel_dimension_mapping_validation_execution_dto: (required) + :type dataservices_datamodel_dimension_mapping_validation_execution_dto: DataservicesDatamodelDimensionMappingValidationExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dimension_member_map_validation_serialize( + object_id=object_id, + dimension_id=dimension_id, + dataservices_datamodel_dimension_mapping_validation_execution_dto=dataservices_datamodel_dimension_mapping_validation_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionMappingValidationDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _dimension_member_map_validation_serialize( + self, + object_id, + dimension_id, + dataservices_datamodel_dimension_mapping_validation_execution_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if object_id is not None: + _path_params['objectId'] = object_id + if dimension_id is not None: + _path_params['dimensionId'] = dimension_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if dataservices_datamodel_dimension_mapping_validation_execution_dto is not None: + _body_params = dataservices_datamodel_dimension_mapping_validation_execution_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/data/model/analytic-objects/{objectId}/dimensions/{dimensionId}/mappings/validate', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def dimensions( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the dimensions to retrieve. Default is all dimensions.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelDimensionsDTO: + """Retrieve a list of dimensions + + Retrieve a list of dimensions for a specific analytic object. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The IDs of the dimensions to retrieve. Default is all dimensions. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dimensions_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def dimensions_with_http_info( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the dimensions to retrieve. Default is all dimensions.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelDimensionsDTO]: + """Retrieve a list of dimensions + + Retrieve a list of dimensions for a specific analytic object. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The IDs of the dimensions to retrieve. Default is all dimensions. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dimensions_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def dimensions_without_preload_content( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the dimensions to retrieve. Default is all dimensions.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of dimensions + + Retrieve a list of dimensions for a specific analytic object. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The IDs of the dimensions to retrieve. Default is all dimensions. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._dimensions_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _dimensions_serialize( + self, + object_id, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects/{objectId}/dimensions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_vee_sample_question( + self, + question_id: Annotated[StrictStr, Field(description="The ID of the Vee sample question to retrieve.")], + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingSampleQuestionAPIResponseDTO: + """Retrieve a Vee sample question's details + + Get the details of a specific Vee sample question where the ID is the `questionID` returned by `GET /v1alpha/data/model/vee/sample-questions`.
**Note:** 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). + + :param question_id: The ID of the Vee sample question to retrieve. (required) + :type question_id: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_question_serialize( + question_id=question_id, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingSampleQuestionAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_vee_sample_question_with_http_info( + self, + question_id: Annotated[StrictStr, Field(description="The ID of the Vee sample question to retrieve.")], + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingSampleQuestionAPIResponseDTO]: + """Retrieve a Vee sample question's details + + Get the details of a specific Vee sample question where the ID is the `questionID` returned by `GET /v1alpha/data/model/vee/sample-questions`.
**Note:** 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). + + :param question_id: The ID of the Vee sample question to retrieve. (required) + :type question_id: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_question_serialize( + question_id=question_id, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingSampleQuestionAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_vee_sample_question_without_preload_content( + self, + question_id: Annotated[StrictStr, Field(description="The ID of the Vee sample question to retrieve.")], + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a Vee sample question's details + + Get the details of a specific Vee sample question where the ID is the `questionID` returned by `GET /v1alpha/data/model/vee/sample-questions`.
**Note:** 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). + + :param question_id: The ID of the Vee sample question to retrieve. (required) + :type question_id: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_question_serialize( + question_id=question_id, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingSampleQuestionAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_vee_sample_question_serialize( + self, + question_id, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if question_id is not None: + _path_params['questionId'] = question_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/data/model/vee/sample-questions/{questionId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_vee_sample_question_categories( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingQuestionCategoriesAPIResponseDTO: + """Retrieve a list of all Vee question categories + + Get a list of all categories for Vee sample questions. Administrating tenants can specify the tenant from which to retrieve categories using the `TargetTenantID` header.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_question_categories_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingQuestionCategoriesAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_vee_sample_question_categories_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingQuestionCategoriesAPIResponseDTO]: + """Retrieve a list of all Vee question categories + + Get a list of all categories for Vee sample questions. Administrating tenants can specify the tenant from which to retrieve categories using the `TargetTenantID` header.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_question_categories_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingQuestionCategoriesAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_vee_sample_question_categories_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all Vee question categories + + Get a list of all categories for Vee sample questions. Administrating tenants can specify the tenant from which to retrieve categories using the `TargetTenantID` header.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_question_categories_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingQuestionCategoriesAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_vee_sample_question_categories_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/data/model/vee/sample-question-categories', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_vee_sample_question_category( + self, + question_category_id: Annotated[StrictStr, Field(description="The ID of the Vee sample question category to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingQuestionCategoryAPIResponseDTO: + """Retrieve a Vee question category's details + + Get the details of a specific Vee sample question category where the ID is the `categoryID` returned by `GET /v1alpha/data/model/vee/sample-question-categories`.
**Note:** 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). + + :param question_category_id: The ID of the Vee sample question category to retrieve. (required) + :type question_category_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_question_category_serialize( + question_category_id=question_category_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingQuestionCategoryAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_vee_sample_question_category_with_http_info( + self, + question_category_id: Annotated[StrictStr, Field(description="The ID of the Vee sample question category to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingQuestionCategoryAPIResponseDTO]: + """Retrieve a Vee question category's details + + Get the details of a specific Vee sample question category where the ID is the `categoryID` returned by `GET /v1alpha/data/model/vee/sample-question-categories`.
**Note:** 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). + + :param question_category_id: The ID of the Vee sample question category to retrieve. (required) + :type question_category_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_question_category_serialize( + question_category_id=question_category_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingQuestionCategoryAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_vee_sample_question_category_without_preload_content( + self, + question_category_id: Annotated[StrictStr, Field(description="The ID of the Vee sample question category to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a Vee question category's details + + Get the details of a specific Vee sample question category where the ID is the `categoryID` returned by `GET /v1alpha/data/model/vee/sample-question-categories`.
**Note:** 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). + + :param question_category_id: The ID of the Vee sample question category to retrieve. (required) + :type question_category_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_question_category_serialize( + question_category_id=question_category_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingQuestionCategoryAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_vee_sample_question_category_serialize( + self, + question_category_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if question_category_id is not None: + _path_params['questionCategoryId'] = question_category_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/data/model/vee/sample-question-categories/{questionCategoryId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_vee_sample_questions( + self, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingSampleQuestionsAPIResponseDTO: + """Retrieve a list of all Vee sample questions + + Get a list of all Vee sample questions for a tenant, including sample questions that are not available to end users. Administrating tenants can specify the tenant from which to retrieve sample questions using the `TargetTenantID` header.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_questions_serialize( + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingSampleQuestionsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_vee_sample_questions_with_http_info( + self, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingSampleQuestionsAPIResponseDTO]: + """Retrieve a list of all Vee sample questions + + Get a list of all Vee sample questions for a tenant, including sample questions that are not available to end users. Administrating tenants can specify the tenant from which to retrieve sample questions using the `TargetTenantID` header.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_questions_serialize( + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingSampleQuestionsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_vee_sample_questions_without_preload_content( + self, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all Vee sample questions + + Get a list of all Vee sample questions for a tenant, including sample questions that are not available to end users. Administrating tenants can specify the tenant from which to retrieve sample questions using the `TargetTenantID` header.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_vee_sample_questions_serialize( + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingSampleQuestionsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_vee_sample_questions_serialize( + self, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/data/model/vee/sample-questions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def member( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object.")], + dimension_id: Annotated[StrictStr, Field(description="The ID of the dimension.")], + id: StrictStr, + id2: Annotated[Optional[StrictStr], Field(description="The ID of the member to retrieve.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelMembersDTO: + """Retrieve a dimension member + + If you know the ID of a dimension member, use this API to retrieve that dimension member specifically. You must also know the dimension's ID and the analytic object's ID. + + :param object_id: The ID of the analytic object. (required) + :type object_id: str + :param dimension_id: The ID of the dimension. (required) + :type dimension_id: str + :param id: (required) + :type id: str + :param id2: The ID of the member to retrieve. + :type id2: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._member_serialize( + object_id=object_id, + dimension_id=dimension_id, + id=id, + id2=id2, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMembersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def member_with_http_info( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object.")], + dimension_id: Annotated[StrictStr, Field(description="The ID of the dimension.")], + id: StrictStr, + id2: Annotated[Optional[StrictStr], Field(description="The ID of the member to retrieve.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelMembersDTO]: + """Retrieve a dimension member + + If you know the ID of a dimension member, use this API to retrieve that dimension member specifically. You must also know the dimension's ID and the analytic object's ID. + + :param object_id: The ID of the analytic object. (required) + :type object_id: str + :param dimension_id: The ID of the dimension. (required) + :type dimension_id: str + :param id: (required) + :type id: str + :param id2: The ID of the member to retrieve. + :type id2: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._member_serialize( + object_id=object_id, + dimension_id=dimension_id, + id=id, + id2=id2, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMembersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def member_without_preload_content( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object.")], + dimension_id: Annotated[StrictStr, Field(description="The ID of the dimension.")], + id: StrictStr, + id2: Annotated[Optional[StrictStr], Field(description="The ID of the member to retrieve.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a dimension member + + If you know the ID of a dimension member, use this API to retrieve that dimension member specifically. You must also know the dimension's ID and the analytic object's ID. + + :param object_id: The ID of the analytic object. (required) + :type object_id: str + :param dimension_id: The ID of the dimension. (required) + :type dimension_id: str + :param id: (required) + :type id: str + :param id2: The ID of the member to retrieve. + :type id2: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._member_serialize( + object_id=object_id, + dimension_id=dimension_id, + id=id, + id2=id2, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMembersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _member_serialize( + self, + object_id, + dimension_id, + id, + id2, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if object_id is not None: + _path_params['objectId'] = object_id + if dimension_id is not None: + _path_params['dimensionId'] = dimension_id + if id is not None: + _path_params['id'] = id + # process the query parameters + if id2 is not None: + + _query_params.append(('Id', id2)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects/{objectId}/dimensions/{dimensionId}/members/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def members( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object.")], + dimension_id: Annotated[StrictStr, Field(description="The ID of the dimension.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the members to retrieve. Default is all members.")] = None, + max_level: Annotated[Optional[StrictInt], Field(description="The maximum level in the hierarchy to fetch. The top level of the hierarchy is 0. Default is all levels.")] = None, + filter: Annotated[Optional[StrictStr], Field(description="A regular expression that members must match to be retrieved. Default is to retrieve all members.")] = None, + var_field: Annotated[Optional[StrictStr], Field(description="Indicates the aspect of the member to apply the filter to. Possible values are: - **id**: Match the filter to the member ID. - **display**: Match the filter to the member's display name. - **either**: Match the filter to the member ID or display name. Default is `id`.")] = None, + include_data_members: Annotated[Optional[StrictBool], Field(description="Indicates whether data members are included in the response. Parent-child dimensions only. Default is `false`.")] = None, + offset: Annotated[Optional[StrictInt], Field(description="For paginated member requests against high-cardinality dimensions, the offset of the first member to retrieve. Default is 0. If the `offset` value is specified to a non-default value, all other non-pagination parameters are ignored.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="For paginated member requests against high-cardinality dimensions, the maximum number of members to retrieve. Default is -1, meaning no limit. If the `limit` value is specified to a non-default value, all other non-pagination parameters are ignored.")] = None, + sort_type: Annotated[Optional[StrictStr], Field(description="The order of the members in the response. Valid values: - **configured**: Sorts the members according to their configuration; for example, the configured order of dimension members in the studio experience. - **natural**: Sorts the members by their natural order; for example, sorted in ascending order by level in a parent-child dimension. Default is `natural`.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelMembersDTO: + """Retrieve a list of dimension members + + If you know the ID of a dimension, use this API to retrieve the members of that dimension specifically. You must also know the analytic object's ID. Dimension members exist in a hierarchy. The levels in the hierarchy may be fixed or non-uniform. Leveled dimensions have fixed hierarchies, while parent-child dimensions have non-uniform levels. When you retrieve dimension members with this API, the response returns the level of the dimension and the path to get to that level. For example, in a Location dimension, Vancouver is 3 levels deep: - All > Canada > British Columbia > Vancouver Parent-child hierarchies are non-uniform and exhibit distinct characteristics such as time dependence and data attributes. These traits reflect the dynamic nature of hierarchies, for example, organizational hierarchies. The API response includes elements that express the validity ranges for retrieved members. + + :param object_id: The ID of the analytic object. (required) + :type object_id: str + :param dimension_id: The ID of the dimension. (required) + :type dimension_id: str + :param id: The IDs of the members to retrieve. Default is all members. + :type id: List[str] + :param max_level: The maximum level in the hierarchy to fetch. The top level of the hierarchy is 0. Default is all levels. + :type max_level: int + :param filter: A regular expression that members must match to be retrieved. Default is to retrieve all members. + :type filter: str + :param var_field: Indicates the aspect of the member to apply the filter to. Possible values are: - **id**: Match the filter to the member ID. - **display**: Match the filter to the member's display name. - **either**: Match the filter to the member ID or display name. Default is `id`. + :type var_field: str + :param include_data_members: Indicates whether data members are included in the response. Parent-child dimensions only. Default is `false`. + :type include_data_members: bool + :param offset: For paginated member requests against high-cardinality dimensions, the offset of the first member to retrieve. Default is 0. If the `offset` value is specified to a non-default value, all other non-pagination parameters are ignored. + :type offset: int + :param limit: For paginated member requests against high-cardinality dimensions, the maximum number of members to retrieve. Default is -1, meaning no limit. If the `limit` value is specified to a non-default value, all other non-pagination parameters are ignored. + :type limit: int + :param sort_type: The order of the members in the response. Valid values: - **configured**: Sorts the members according to their configuration; for example, the configured order of dimension members in the studio experience. - **natural**: Sorts the members by their natural order; for example, sorted in ascending order by level in a parent-child dimension. Default is `natural`. + :type sort_type: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._members_serialize( + object_id=object_id, + dimension_id=dimension_id, + id=id, + max_level=max_level, + filter=filter, + var_field=var_field, + include_data_members=include_data_members, + offset=offset, + limit=limit, + sort_type=sort_type, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMembersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def members_with_http_info( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object.")], + dimension_id: Annotated[StrictStr, Field(description="The ID of the dimension.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the members to retrieve. Default is all members.")] = None, + max_level: Annotated[Optional[StrictInt], Field(description="The maximum level in the hierarchy to fetch. The top level of the hierarchy is 0. Default is all levels.")] = None, + filter: Annotated[Optional[StrictStr], Field(description="A regular expression that members must match to be retrieved. Default is to retrieve all members.")] = None, + var_field: Annotated[Optional[StrictStr], Field(description="Indicates the aspect of the member to apply the filter to. Possible values are: - **id**: Match the filter to the member ID. - **display**: Match the filter to the member's display name. - **either**: Match the filter to the member ID or display name. Default is `id`.")] = None, + include_data_members: Annotated[Optional[StrictBool], Field(description="Indicates whether data members are included in the response. Parent-child dimensions only. Default is `false`.")] = None, + offset: Annotated[Optional[StrictInt], Field(description="For paginated member requests against high-cardinality dimensions, the offset of the first member to retrieve. Default is 0. If the `offset` value is specified to a non-default value, all other non-pagination parameters are ignored.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="For paginated member requests against high-cardinality dimensions, the maximum number of members to retrieve. Default is -1, meaning no limit. If the `limit` value is specified to a non-default value, all other non-pagination parameters are ignored.")] = None, + sort_type: Annotated[Optional[StrictStr], Field(description="The order of the members in the response. Valid values: - **configured**: Sorts the members according to their configuration; for example, the configured order of dimension members in the studio experience. - **natural**: Sorts the members by their natural order; for example, sorted in ascending order by level in a parent-child dimension. Default is `natural`.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelMembersDTO]: + """Retrieve a list of dimension members + + If you know the ID of a dimension, use this API to retrieve the members of that dimension specifically. You must also know the analytic object's ID. Dimension members exist in a hierarchy. The levels in the hierarchy may be fixed or non-uniform. Leveled dimensions have fixed hierarchies, while parent-child dimensions have non-uniform levels. When you retrieve dimension members with this API, the response returns the level of the dimension and the path to get to that level. For example, in a Location dimension, Vancouver is 3 levels deep: - All > Canada > British Columbia > Vancouver Parent-child hierarchies are non-uniform and exhibit distinct characteristics such as time dependence and data attributes. These traits reflect the dynamic nature of hierarchies, for example, organizational hierarchies. The API response includes elements that express the validity ranges for retrieved members. + + :param object_id: The ID of the analytic object. (required) + :type object_id: str + :param dimension_id: The ID of the dimension. (required) + :type dimension_id: str + :param id: The IDs of the members to retrieve. Default is all members. + :type id: List[str] + :param max_level: The maximum level in the hierarchy to fetch. The top level of the hierarchy is 0. Default is all levels. + :type max_level: int + :param filter: A regular expression that members must match to be retrieved. Default is to retrieve all members. + :type filter: str + :param var_field: Indicates the aspect of the member to apply the filter to. Possible values are: - **id**: Match the filter to the member ID. - **display**: Match the filter to the member's display name. - **either**: Match the filter to the member ID or display name. Default is `id`. + :type var_field: str + :param include_data_members: Indicates whether data members are included in the response. Parent-child dimensions only. Default is `false`. + :type include_data_members: bool + :param offset: For paginated member requests against high-cardinality dimensions, the offset of the first member to retrieve. Default is 0. If the `offset` value is specified to a non-default value, all other non-pagination parameters are ignored. + :type offset: int + :param limit: For paginated member requests against high-cardinality dimensions, the maximum number of members to retrieve. Default is -1, meaning no limit. If the `limit` value is specified to a non-default value, all other non-pagination parameters are ignored. + :type limit: int + :param sort_type: The order of the members in the response. Valid values: - **configured**: Sorts the members according to their configuration; for example, the configured order of dimension members in the studio experience. - **natural**: Sorts the members by their natural order; for example, sorted in ascending order by level in a parent-child dimension. Default is `natural`. + :type sort_type: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._members_serialize( + object_id=object_id, + dimension_id=dimension_id, + id=id, + max_level=max_level, + filter=filter, + var_field=var_field, + include_data_members=include_data_members, + offset=offset, + limit=limit, + sort_type=sort_type, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMembersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def members_without_preload_content( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object.")], + dimension_id: Annotated[StrictStr, Field(description="The ID of the dimension.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the members to retrieve. Default is all members.")] = None, + max_level: Annotated[Optional[StrictInt], Field(description="The maximum level in the hierarchy to fetch. The top level of the hierarchy is 0. Default is all levels.")] = None, + filter: Annotated[Optional[StrictStr], Field(description="A regular expression that members must match to be retrieved. Default is to retrieve all members.")] = None, + var_field: Annotated[Optional[StrictStr], Field(description="Indicates the aspect of the member to apply the filter to. Possible values are: - **id**: Match the filter to the member ID. - **display**: Match the filter to the member's display name. - **either**: Match the filter to the member ID or display name. Default is `id`.")] = None, + include_data_members: Annotated[Optional[StrictBool], Field(description="Indicates whether data members are included in the response. Parent-child dimensions only. Default is `false`.")] = None, + offset: Annotated[Optional[StrictInt], Field(description="For paginated member requests against high-cardinality dimensions, the offset of the first member to retrieve. Default is 0. If the `offset` value is specified to a non-default value, all other non-pagination parameters are ignored.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="For paginated member requests against high-cardinality dimensions, the maximum number of members to retrieve. Default is -1, meaning no limit. If the `limit` value is specified to a non-default value, all other non-pagination parameters are ignored.")] = None, + sort_type: Annotated[Optional[StrictStr], Field(description="The order of the members in the response. Valid values: - **configured**: Sorts the members according to their configuration; for example, the configured order of dimension members in the studio experience. - **natural**: Sorts the members by their natural order; for example, sorted in ascending order by level in a parent-child dimension. Default is `natural`.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of dimension members + + If you know the ID of a dimension, use this API to retrieve the members of that dimension specifically. You must also know the analytic object's ID. Dimension members exist in a hierarchy. The levels in the hierarchy may be fixed or non-uniform. Leveled dimensions have fixed hierarchies, while parent-child dimensions have non-uniform levels. When you retrieve dimension members with this API, the response returns the level of the dimension and the path to get to that level. For example, in a Location dimension, Vancouver is 3 levels deep: - All > Canada > British Columbia > Vancouver Parent-child hierarchies are non-uniform and exhibit distinct characteristics such as time dependence and data attributes. These traits reflect the dynamic nature of hierarchies, for example, organizational hierarchies. The API response includes elements that express the validity ranges for retrieved members. + + :param object_id: The ID of the analytic object. (required) + :type object_id: str + :param dimension_id: The ID of the dimension. (required) + :type dimension_id: str + :param id: The IDs of the members to retrieve. Default is all members. + :type id: List[str] + :param max_level: The maximum level in the hierarchy to fetch. The top level of the hierarchy is 0. Default is all levels. + :type max_level: int + :param filter: A regular expression that members must match to be retrieved. Default is to retrieve all members. + :type filter: str + :param var_field: Indicates the aspect of the member to apply the filter to. Possible values are: - **id**: Match the filter to the member ID. - **display**: Match the filter to the member's display name. - **either**: Match the filter to the member ID or display name. Default is `id`. + :type var_field: str + :param include_data_members: Indicates whether data members are included in the response. Parent-child dimensions only. Default is `false`. + :type include_data_members: bool + :param offset: For paginated member requests against high-cardinality dimensions, the offset of the first member to retrieve. Default is 0. If the `offset` value is specified to a non-default value, all other non-pagination parameters are ignored. + :type offset: int + :param limit: For paginated member requests against high-cardinality dimensions, the maximum number of members to retrieve. Default is -1, meaning no limit. If the `limit` value is specified to a non-default value, all other non-pagination parameters are ignored. + :type limit: int + :param sort_type: The order of the members in the response. Valid values: - **configured**: Sorts the members according to their configuration; for example, the configured order of dimension members in the studio experience. - **natural**: Sorts the members by their natural order; for example, sorted in ascending order by level in a parent-child dimension. Default is `natural`. + :type sort_type: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._members_serialize( + object_id=object_id, + dimension_id=dimension_id, + id=id, + max_level=max_level, + filter=filter, + var_field=var_field, + include_data_members=include_data_members, + offset=offset, + limit=limit, + sort_type=sort_type, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMembersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _members_serialize( + self, + object_id, + dimension_id, + id, + max_level, + filter, + var_field, + include_data_members, + offset, + limit, + sort_type, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if object_id is not None: + _path_params['objectId'] = object_id + if dimension_id is not None: + _path_params['dimensionId'] = dimension_id + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + if max_level is not None: + + _query_params.append(('maxLevel', max_level)) + + if filter is not None: + + _query_params.append(('filter', filter)) + + if var_field is not None: + + _query_params.append(('field', var_field)) + + if include_data_members is not None: + + _query_params.append(('includeDataMembers', include_data_members)) + + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if sort_type is not None: + + _query_params.append(('sortType', sort_type)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects/{objectId}/dimensions/{dimensionId}/members', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def metric( + self, + id: Annotated[StrictStr, Field(description="The ID of the metric to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelMetricDTO: + """Retrieve a metric by ID + + If you know the ID of a metric, use this API to retrieve that metric specifically. + + :param id: The ID of the metric to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metric_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def metric_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ID of the metric to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelMetricDTO]: + """Retrieve a metric by ID + + If you know the ID of a metric, use this API to retrieve that metric specifically. + + :param id: The ID of the metric to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metric_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def metric_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ID of the metric to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a metric by ID + + If you know the ID of a metric, use this API to retrieve that metric specifically. + + :param id: The ID of the metric to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metric_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _metric_serialize( + self, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/metrics/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def metric_dimensions( + self, + metric_id: Annotated[StrictStr, Field(description="The ID of the metric to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the dimensions to retrieve. Default is all dimensions.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelDimensionsDTO: + """Retrieve a metric's dimensions + + Retrieve a list of dimensions for a specific metric. + + :param metric_id: The ID of the metric to retrieve. (required) + :type metric_id: str + :param id: The IDs of the dimensions to retrieve. Default is all dimensions. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metric_dimensions_serialize( + metric_id=metric_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def metric_dimensions_with_http_info( + self, + metric_id: Annotated[StrictStr, Field(description="The ID of the metric to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the dimensions to retrieve. Default is all dimensions.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelDimensionsDTO]: + """Retrieve a metric's dimensions + + Retrieve a list of dimensions for a specific metric. + + :param metric_id: The ID of the metric to retrieve. (required) + :type metric_id: str + :param id: The IDs of the dimensions to retrieve. Default is all dimensions. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metric_dimensions_serialize( + metric_id=metric_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def metric_dimensions_without_preload_content( + self, + metric_id: Annotated[StrictStr, Field(description="The ID of the metric to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the dimensions to retrieve. Default is all dimensions.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a metric's dimensions + + Retrieve a list of dimensions for a specific metric. + + :param metric_id: The ID of the metric to retrieve. (required) + :type metric_id: str + :param id: The IDs of the dimensions to retrieve. Default is all dimensions. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metric_dimensions_serialize( + metric_id=metric_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelDimensionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _metric_dimensions_serialize( + self, + metric_id, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if metric_id is not None: + _path_params['metricId'] = metric_id + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/metrics/{metricId}/dimensions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def metric_selection_concepts( + self, + metric_id: Annotated[StrictStr, Field(description="The ID of the metric to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the selection concepts to retrieve. Default is all selection concepts.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelSelectionConceptsDTO: + """Retrieve a metric's selection concepts + + Retrieve a list of selection concepts for a specific metric. + + :param metric_id: The ID of the metric to retrieve. (required) + :type metric_id: str + :param id: The IDs of the selection concepts to retrieve. Default is all selection concepts. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metric_selection_concepts_serialize( + metric_id=metric_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelSelectionConceptsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def metric_selection_concepts_with_http_info( + self, + metric_id: Annotated[StrictStr, Field(description="The ID of the metric to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the selection concepts to retrieve. Default is all selection concepts.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelSelectionConceptsDTO]: + """Retrieve a metric's selection concepts + + Retrieve a list of selection concepts for a specific metric. + + :param metric_id: The ID of the metric to retrieve. (required) + :type metric_id: str + :param id: The IDs of the selection concepts to retrieve. Default is all selection concepts. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metric_selection_concepts_serialize( + metric_id=metric_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelSelectionConceptsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def metric_selection_concepts_without_preload_content( + self, + metric_id: Annotated[StrictStr, Field(description="The ID of the metric to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the selection concepts to retrieve. Default is all selection concepts.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a metric's selection concepts + + Retrieve a list of selection concepts for a specific metric. + + :param metric_id: The ID of the metric to retrieve. (required) + :type metric_id: str + :param id: The IDs of the selection concepts to retrieve. Default is all selection concepts. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metric_selection_concepts_serialize( + metric_id=metric_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelSelectionConceptsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _metric_selection_concepts_serialize( + self, + metric_id, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if metric_id is not None: + _path_params['metricId'] = metric_id + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/metrics/{metricId}/selection-concepts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def metrics( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the metrics to retrieve. Default is all metrics.")] = None, + category: Annotated[Optional[StrictStr], Field(description="The category to filter the returned metrics by.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelMetricsDTO: + """Retrieve a list of metrics + + Retrieve all the metrics in your Visier solution. + + :param id: The IDs of the metrics to retrieve. Default is all metrics. + :type id: List[str] + :param category: The category to filter the returned metrics by. + :type category: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metrics_serialize( + id=id, + category=category, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def metrics_with_http_info( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the metrics to retrieve. Default is all metrics.")] = None, + category: Annotated[Optional[StrictStr], Field(description="The category to filter the returned metrics by.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelMetricsDTO]: + """Retrieve a list of metrics + + Retrieve all the metrics in your Visier solution. + + :param id: The IDs of the metrics to retrieve. Default is all metrics. + :type id: List[str] + :param category: The category to filter the returned metrics by. + :type category: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metrics_serialize( + id=id, + category=category, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def metrics_without_preload_content( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the metrics to retrieve. Default is all metrics.")] = None, + category: Annotated[Optional[StrictStr], Field(description="The category to filter the returned metrics by.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of metrics + + Retrieve all the metrics in your Visier solution. + + :param id: The IDs of the metrics to retrieve. Default is all metrics. + :type id: List[str] + :param category: The category to filter the returned metrics by. + :type category: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._metrics_serialize( + id=id, + category=category, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _metrics_serialize( + self, + id, + category, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + if category is not None: + + _query_params.append(('category', category)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/metrics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def plan_data_loadl_list( + self, + display_name: Annotated[Optional[StrictStr], Field(description="Returns plans that match the specified display name. Ignores text case and includes partial matches. For example, `displayName=WFP Plan` returns plans named \"WFP Plan 2024\", \"WFP plan v1\", and \"WFP plan - Product\".")] = None, + model: Annotated[Optional[StrictStr], Field(description="Returns plans that belong to the specified planning model ID.")] = None, + plan_status: Annotated[Optional[StrictStr], Field(description="Returns plans with the specified plan status. Valid values: - **ASSIGNED**: The subplan has been assigned to a subplanner. - **IN_PROGRESS**: The subplanner has opened the subplan. - **OVERDUE**: The subplan was not completed on time. - **SUBMITTED**: The subplan has been submitted for review. - **SENT_BACK**: The subplan was rejected and returned to the subplanner for editing. - **CONSOLIDATED**: The subplan has been accepted and combined into the primary plan.")] = None, + created_start: Annotated[Optional[StrictStr], Field(description="Returns plans created on or after this date. The format is YYYY-MM-DD.")] = None, + created_end: Annotated[Optional[StrictStr], Field(description="Return plans created on or before this date. The format is YYYY-MM-DD.")] = None, + edited_start: Annotated[Optional[StrictStr], Field(description="Returns plans edited on or after this date. The format is YYYY-MM-DD.")] = None, + edited_end: Annotated[Optional[StrictStr], Field(description="Returns plans edited on or before this date. The format is YYYY-MM-DD.")] = None, + order_by: Annotated[Optional[StrictStr], Field(description="Orders plan results by the specified value. Valid values: - **LAST_EDITED_DATE**: Orders plans by the last edited date. This is the default. - **CREATED_DATE**: Orders plans by the creation date. - **PLAN_MODEL**: Orders plans alphabetically by planning model.")] = None, + sort_order: Annotated[Optional[StrictStr], Field(description="Sorts plan results by the specified value. Valid values are `ASCENDING` or `DESCENDING`. Default is `DESCENDING`.")] = None, + exclude_subplans: Annotated[Optional[StrictBool], Field(description="If `true`, the response doesn't return subplans. Default is `true`.")] = None, + max_results: Annotated[Optional[StrictStr], Field(description="Sets the maximum number of results to return per page. Default is 50.")] = None, + page: Annotated[Optional[StrictStr], Field(description="Sets the results page to return. If undefined, returns the first 50 results. To get the next 50 results, specify `page=2`.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PlanningGetPlanListResponseDTO: + """Retrieve a list of plans + + Retrieve all the plans you have access to. The response returns plan information you can use to call the Planning Data Load API.
**Note:** 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). + + :param display_name: Returns plans that match the specified display name. Ignores text case and includes partial matches. For example, `displayName=WFP Plan` returns plans named \"WFP Plan 2024\", \"WFP plan v1\", and \"WFP plan - Product\". + :type display_name: str + :param model: Returns plans that belong to the specified planning model ID. + :type model: str + :param plan_status: Returns plans with the specified plan status. Valid values: - **ASSIGNED**: The subplan has been assigned to a subplanner. - **IN_PROGRESS**: The subplanner has opened the subplan. - **OVERDUE**: The subplan was not completed on time. - **SUBMITTED**: The subplan has been submitted for review. - **SENT_BACK**: The subplan was rejected and returned to the subplanner for editing. - **CONSOLIDATED**: The subplan has been accepted and combined into the primary plan. + :type plan_status: str + :param created_start: Returns plans created on or after this date. The format is YYYY-MM-DD. + :type created_start: str + :param created_end: Return plans created on or before this date. The format is YYYY-MM-DD. + :type created_end: str + :param edited_start: Returns plans edited on or after this date. The format is YYYY-MM-DD. + :type edited_start: str + :param edited_end: Returns plans edited on or before this date. The format is YYYY-MM-DD. + :type edited_end: str + :param order_by: Orders plan results by the specified value. Valid values: - **LAST_EDITED_DATE**: Orders plans by the last edited date. This is the default. - **CREATED_DATE**: Orders plans by the creation date. - **PLAN_MODEL**: Orders plans alphabetically by planning model. + :type order_by: str + :param sort_order: Sorts plan results by the specified value. Valid values are `ASCENDING` or `DESCENDING`. Default is `DESCENDING`. + :type sort_order: str + :param exclude_subplans: If `true`, the response doesn't return subplans. Default is `true`. + :type exclude_subplans: bool + :param max_results: Sets the maximum number of results to return per page. Default is 50. + :type max_results: str + :param page: Sets the results page to return. If undefined, returns the first 50 results. To get the next 50 results, specify `page=2`. + :type page: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_data_loadl_list_serialize( + display_name=display_name, + model=model, + plan_status=plan_status, + created_start=created_start, + created_end=created_end, + edited_start=edited_start, + edited_end=edited_end, + order_by=order_by, + sort_order=sort_order, + exclude_subplans=exclude_subplans, + max_results=max_results, + page=page, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanningGetPlanListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def plan_data_loadl_list_with_http_info( + self, + display_name: Annotated[Optional[StrictStr], Field(description="Returns plans that match the specified display name. Ignores text case and includes partial matches. For example, `displayName=WFP Plan` returns plans named \"WFP Plan 2024\", \"WFP plan v1\", and \"WFP plan - Product\".")] = None, + model: Annotated[Optional[StrictStr], Field(description="Returns plans that belong to the specified planning model ID.")] = None, + plan_status: Annotated[Optional[StrictStr], Field(description="Returns plans with the specified plan status. Valid values: - **ASSIGNED**: The subplan has been assigned to a subplanner. - **IN_PROGRESS**: The subplanner has opened the subplan. - **OVERDUE**: The subplan was not completed on time. - **SUBMITTED**: The subplan has been submitted for review. - **SENT_BACK**: The subplan was rejected and returned to the subplanner for editing. - **CONSOLIDATED**: The subplan has been accepted and combined into the primary plan.")] = None, + created_start: Annotated[Optional[StrictStr], Field(description="Returns plans created on or after this date. The format is YYYY-MM-DD.")] = None, + created_end: Annotated[Optional[StrictStr], Field(description="Return plans created on or before this date. The format is YYYY-MM-DD.")] = None, + edited_start: Annotated[Optional[StrictStr], Field(description="Returns plans edited on or after this date. The format is YYYY-MM-DD.")] = None, + edited_end: Annotated[Optional[StrictStr], Field(description="Returns plans edited on or before this date. The format is YYYY-MM-DD.")] = None, + order_by: Annotated[Optional[StrictStr], Field(description="Orders plan results by the specified value. Valid values: - **LAST_EDITED_DATE**: Orders plans by the last edited date. This is the default. - **CREATED_DATE**: Orders plans by the creation date. - **PLAN_MODEL**: Orders plans alphabetically by planning model.")] = None, + sort_order: Annotated[Optional[StrictStr], Field(description="Sorts plan results by the specified value. Valid values are `ASCENDING` or `DESCENDING`. Default is `DESCENDING`.")] = None, + exclude_subplans: Annotated[Optional[StrictBool], Field(description="If `true`, the response doesn't return subplans. Default is `true`.")] = None, + max_results: Annotated[Optional[StrictStr], Field(description="Sets the maximum number of results to return per page. Default is 50.")] = None, + page: Annotated[Optional[StrictStr], Field(description="Sets the results page to return. If undefined, returns the first 50 results. To get the next 50 results, specify `page=2`.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PlanningGetPlanListResponseDTO]: + """Retrieve a list of plans + + Retrieve all the plans you have access to. The response returns plan information you can use to call the Planning Data Load API.
**Note:** 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). + + :param display_name: Returns plans that match the specified display name. Ignores text case and includes partial matches. For example, `displayName=WFP Plan` returns plans named \"WFP Plan 2024\", \"WFP plan v1\", and \"WFP plan - Product\". + :type display_name: str + :param model: Returns plans that belong to the specified planning model ID. + :type model: str + :param plan_status: Returns plans with the specified plan status. Valid values: - **ASSIGNED**: The subplan has been assigned to a subplanner. - **IN_PROGRESS**: The subplanner has opened the subplan. - **OVERDUE**: The subplan was not completed on time. - **SUBMITTED**: The subplan has been submitted for review. - **SENT_BACK**: The subplan was rejected and returned to the subplanner for editing. - **CONSOLIDATED**: The subplan has been accepted and combined into the primary plan. + :type plan_status: str + :param created_start: Returns plans created on or after this date. The format is YYYY-MM-DD. + :type created_start: str + :param created_end: Return plans created on or before this date. The format is YYYY-MM-DD. + :type created_end: str + :param edited_start: Returns plans edited on or after this date. The format is YYYY-MM-DD. + :type edited_start: str + :param edited_end: Returns plans edited on or before this date. The format is YYYY-MM-DD. + :type edited_end: str + :param order_by: Orders plan results by the specified value. Valid values: - **LAST_EDITED_DATE**: Orders plans by the last edited date. This is the default. - **CREATED_DATE**: Orders plans by the creation date. - **PLAN_MODEL**: Orders plans alphabetically by planning model. + :type order_by: str + :param sort_order: Sorts plan results by the specified value. Valid values are `ASCENDING` or `DESCENDING`. Default is `DESCENDING`. + :type sort_order: str + :param exclude_subplans: If `true`, the response doesn't return subplans. Default is `true`. + :type exclude_subplans: bool + :param max_results: Sets the maximum number of results to return per page. Default is 50. + :type max_results: str + :param page: Sets the results page to return. If undefined, returns the first 50 results. To get the next 50 results, specify `page=2`. + :type page: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_data_loadl_list_serialize( + display_name=display_name, + model=model, + plan_status=plan_status, + created_start=created_start, + created_end=created_end, + edited_start=edited_start, + edited_end=edited_end, + order_by=order_by, + sort_order=sort_order, + exclude_subplans=exclude_subplans, + max_results=max_results, + page=page, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanningGetPlanListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def plan_data_loadl_list_without_preload_content( + self, + display_name: Annotated[Optional[StrictStr], Field(description="Returns plans that match the specified display name. Ignores text case and includes partial matches. For example, `displayName=WFP Plan` returns plans named \"WFP Plan 2024\", \"WFP plan v1\", and \"WFP plan - Product\".")] = None, + model: Annotated[Optional[StrictStr], Field(description="Returns plans that belong to the specified planning model ID.")] = None, + plan_status: Annotated[Optional[StrictStr], Field(description="Returns plans with the specified plan status. Valid values: - **ASSIGNED**: The subplan has been assigned to a subplanner. - **IN_PROGRESS**: The subplanner has opened the subplan. - **OVERDUE**: The subplan was not completed on time. - **SUBMITTED**: The subplan has been submitted for review. - **SENT_BACK**: The subplan was rejected and returned to the subplanner for editing. - **CONSOLIDATED**: The subplan has been accepted and combined into the primary plan.")] = None, + created_start: Annotated[Optional[StrictStr], Field(description="Returns plans created on or after this date. The format is YYYY-MM-DD.")] = None, + created_end: Annotated[Optional[StrictStr], Field(description="Return plans created on or before this date. The format is YYYY-MM-DD.")] = None, + edited_start: Annotated[Optional[StrictStr], Field(description="Returns plans edited on or after this date. The format is YYYY-MM-DD.")] = None, + edited_end: Annotated[Optional[StrictStr], Field(description="Returns plans edited on or before this date. The format is YYYY-MM-DD.")] = None, + order_by: Annotated[Optional[StrictStr], Field(description="Orders plan results by the specified value. Valid values: - **LAST_EDITED_DATE**: Orders plans by the last edited date. This is the default. - **CREATED_DATE**: Orders plans by the creation date. - **PLAN_MODEL**: Orders plans alphabetically by planning model.")] = None, + sort_order: Annotated[Optional[StrictStr], Field(description="Sorts plan results by the specified value. Valid values are `ASCENDING` or `DESCENDING`. Default is `DESCENDING`.")] = None, + exclude_subplans: Annotated[Optional[StrictBool], Field(description="If `true`, the response doesn't return subplans. Default is `true`.")] = None, + max_results: Annotated[Optional[StrictStr], Field(description="Sets the maximum number of results to return per page. Default is 50.")] = None, + page: Annotated[Optional[StrictStr], Field(description="Sets the results page to return. If undefined, returns the first 50 results. To get the next 50 results, specify `page=2`.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of plans + + Retrieve all the plans you have access to. The response returns plan information you can use to call the Planning Data Load API.
**Note:** 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). + + :param display_name: Returns plans that match the specified display name. Ignores text case and includes partial matches. For example, `displayName=WFP Plan` returns plans named \"WFP Plan 2024\", \"WFP plan v1\", and \"WFP plan - Product\". + :type display_name: str + :param model: Returns plans that belong to the specified planning model ID. + :type model: str + :param plan_status: Returns plans with the specified plan status. Valid values: - **ASSIGNED**: The subplan has been assigned to a subplanner. - **IN_PROGRESS**: The subplanner has opened the subplan. - **OVERDUE**: The subplan was not completed on time. - **SUBMITTED**: The subplan has been submitted for review. - **SENT_BACK**: The subplan was rejected and returned to the subplanner for editing. - **CONSOLIDATED**: The subplan has been accepted and combined into the primary plan. + :type plan_status: str + :param created_start: Returns plans created on or after this date. The format is YYYY-MM-DD. + :type created_start: str + :param created_end: Return plans created on or before this date. The format is YYYY-MM-DD. + :type created_end: str + :param edited_start: Returns plans edited on or after this date. The format is YYYY-MM-DD. + :type edited_start: str + :param edited_end: Returns plans edited on or before this date. The format is YYYY-MM-DD. + :type edited_end: str + :param order_by: Orders plan results by the specified value. Valid values: - **LAST_EDITED_DATE**: Orders plans by the last edited date. This is the default. - **CREATED_DATE**: Orders plans by the creation date. - **PLAN_MODEL**: Orders plans alphabetically by planning model. + :type order_by: str + :param sort_order: Sorts plan results by the specified value. Valid values are `ASCENDING` or `DESCENDING`. Default is `DESCENDING`. + :type sort_order: str + :param exclude_subplans: If `true`, the response doesn't return subplans. Default is `true`. + :type exclude_subplans: bool + :param max_results: Sets the maximum number of results to return per page. Default is 50. + :type max_results: str + :param page: Sets the results page to return. If undefined, returns the first 50 results. To get the next 50 results, specify `page=2`. + :type page: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_data_loadl_list_serialize( + display_name=display_name, + model=model, + plan_status=plan_status, + created_start=created_start, + created_end=created_end, + edited_start=edited_start, + edited_end=edited_end, + order_by=order_by, + sort_order=sort_order, + exclude_subplans=exclude_subplans, + max_results=max_results, + page=page, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanningGetPlanListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _plan_data_loadl_list_serialize( + self, + display_name, + model, + plan_status, + created_start, + created_end, + edited_start, + edited_end, + order_by, + sort_order, + exclude_subplans, + max_results, + page, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if display_name is not None: + + _query_params.append(('displayName', display_name)) + + if model is not None: + + _query_params.append(('model', model)) + + if plan_status is not None: + + _query_params.append(('planStatus', plan_status)) + + if created_start is not None: + + _query_params.append(('createdStart', created_start)) + + if created_end is not None: + + _query_params.append(('createdEnd', created_end)) + + if edited_start is not None: + + _query_params.append(('editedStart', edited_start)) + + if edited_end is not None: + + _query_params.append(('editedEnd', edited_end)) + + if order_by is not None: + + _query_params.append(('orderBy', order_by)) + + if sort_order is not None: + + _query_params.append(('sortOrder', sort_order)) + + if exclude_subplans is not None: + + _query_params.append(('excludeSubplans', exclude_subplans)) + + if max_results is not None: + + _query_params.append(('maxResults', max_results)) + + if page is not None: + + _query_params.append(('page', page)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/planning/model/plans', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def plan_info_with_schema( + self, + id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")], + with_schema: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns the plan's schema. Default is `false`.")] = None, + segment_id_filter: Annotated[Optional[StrictStr], Field(description="If defined, returns segment levels and members for the specified segment.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PlanningPlanWithSchemaDTO: + """Retrieve a plan's details + + Retrieve the details of a specific plan. The response returns plan information you can use to call the Planning Data Load API.
**Note:** 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). + + :param id: The unique identifier of the plan. (required) + :type id: str + :param with_schema: If `true`, the response returns the plan's schema. Default is `false`. + :type with_schema: bool + :param segment_id_filter: If defined, returns segment levels and members for the specified segment. + :type segment_id_filter: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_info_with_schema_serialize( + id=id, + with_schema=with_schema, + segment_id_filter=segment_id_filter, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanningPlanWithSchemaDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def plan_info_with_schema_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")], + with_schema: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns the plan's schema. Default is `false`.")] = None, + segment_id_filter: Annotated[Optional[StrictStr], Field(description="If defined, returns segment levels and members for the specified segment.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PlanningPlanWithSchemaDTO]: + """Retrieve a plan's details + + Retrieve the details of a specific plan. The response returns plan information you can use to call the Planning Data Load API.
**Note:** 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). + + :param id: The unique identifier of the plan. (required) + :type id: str + :param with_schema: If `true`, the response returns the plan's schema. Default is `false`. + :type with_schema: bool + :param segment_id_filter: If defined, returns segment levels and members for the specified segment. + :type segment_id_filter: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_info_with_schema_serialize( + id=id, + with_schema=with_schema, + segment_id_filter=segment_id_filter, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanningPlanWithSchemaDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def plan_info_with_schema_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")], + with_schema: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns the plan's schema. Default is `false`.")] = None, + segment_id_filter: Annotated[Optional[StrictStr], Field(description="If defined, returns segment levels and members for the specified segment.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a plan's details + + Retrieve the details of a specific plan. The response returns plan information you can use to call the Planning Data Load API.
**Note:** 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). + + :param id: The unique identifier of the plan. (required) + :type id: str + :param with_schema: If `true`, the response returns the plan's schema. Default is `false`. + :type with_schema: bool + :param segment_id_filter: If defined, returns segment levels and members for the specified segment. + :type segment_id_filter: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_info_with_schema_serialize( + id=id, + with_schema=with_schema, + segment_id_filter=segment_id_filter, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanningPlanWithSchemaDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _plan_info_with_schema_serialize( + self, + id, + with_schema, + segment_id_filter, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + if with_schema is not None: + + _query_params.append(('withSchema', with_schema)) + + if segment_id_filter is not None: + + _query_params.append(('segmentIdFilter', segment_id_filter)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/planning/model/plans/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def planning_metrics( + self, + id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelMetricsDTO: + """Retrieve metrics by planning model ID + + Retrieve all the metrics you have access to for a planning model. + + :param id: The ID of the planning model to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_metrics_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def planning_metrics_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelMetricsDTO]: + """Retrieve metrics by planning model ID + + Retrieve all the metrics you have access to for a planning model. + + :param id: The ID of the planning model to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_metrics_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def planning_metrics_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve metrics by planning model ID + + Retrieve all the metrics you have access to for a planning model. + + :param id: The ID of the planning model to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_metrics_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelMetricsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _planning_metrics_serialize( + self, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/plan-models/{id}/metrics', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def planning_model( + self, + id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelPlanningModelDTO: + """Retrieve a planning model by ID + + Retrieve a specific planning model you have access to. + + :param id: The ID of the planning model to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_model_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningModelDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def planning_model_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelPlanningModelDTO]: + """Retrieve a planning model by ID + + Retrieve a specific planning model you have access to. + + :param id: The ID of the planning model to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_model_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningModelDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def planning_model_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a planning model by ID + + Retrieve a specific planning model you have access to. + + :param id: The ID of the planning model to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_model_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningModelDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _planning_model_serialize( + self, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/plan-models/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def planning_models( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the planning models to retrieve. Default is all models.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelPlanningModelsDTO: + """Retrieve a list of planning models + + Retrieve all the planning models you have access to. + + :param id: The IDs of the planning models to retrieve. Default is all models. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_models_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningModelsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def planning_models_with_http_info( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the planning models to retrieve. Default is all models.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelPlanningModelsDTO]: + """Retrieve a list of planning models + + Retrieve all the planning models you have access to. + + :param id: The IDs of the planning models to retrieve. Default is all models. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_models_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningModelsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def planning_models_without_preload_content( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the planning models to retrieve. Default is all models.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of planning models + + Retrieve all the planning models you have access to. + + :param id: The IDs of the planning models to retrieve. Default is all models. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_models_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningModelsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _planning_models_serialize( + self, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/plan-models', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def planning_plan( + self, + model_id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + id: Annotated[StrictStr, Field(description="The ID of the plan to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelPlanningPlanDTO: + """Retrieve a plan by planning model ID and plan ID + + Retrieve a specific plan that you have access to in a planning model. + + :param model_id: The ID of the planning model to retrieve. (required) + :type model_id: str + :param id: The ID of the plan to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_plan_serialize( + model_id=model_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningPlanDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def planning_plan_with_http_info( + self, + model_id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + id: Annotated[StrictStr, Field(description="The ID of the plan to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelPlanningPlanDTO]: + """Retrieve a plan by planning model ID and plan ID + + Retrieve a specific plan that you have access to in a planning model. + + :param model_id: The ID of the planning model to retrieve. (required) + :type model_id: str + :param id: The ID of the plan to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_plan_serialize( + model_id=model_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningPlanDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def planning_plan_without_preload_content( + self, + model_id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + id: Annotated[StrictStr, Field(description="The ID of the plan to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a plan by planning model ID and plan ID + + Retrieve a specific plan that you have access to in a planning model. + + :param model_id: The ID of the planning model to retrieve. (required) + :type model_id: str + :param id: The ID of the plan to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_plan_serialize( + model_id=model_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningPlanDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _planning_plan_serialize( + self, + model_id, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if model_id is not None: + _path_params['modelId'] = model_id + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/plan-models/{modelId}/plans/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def planning_plans( + self, + model_id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the plans to retrieve. Default is all plans.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelPlanningPlansDTO: + """Retrieve a list of plans by planning model ID + + Retrieve all the plans you have access to for a planning model. + + :param model_id: The ID of the planning model to retrieve. (required) + :type model_id: str + :param id: The IDs of the plans to retrieve. Default is all plans. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_plans_serialize( + model_id=model_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningPlansDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def planning_plans_with_http_info( + self, + model_id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the plans to retrieve. Default is all plans.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelPlanningPlansDTO]: + """Retrieve a list of plans by planning model ID + + Retrieve all the plans you have access to for a planning model. + + :param model_id: The ID of the planning model to retrieve. (required) + :type model_id: str + :param id: The IDs of the plans to retrieve. Default is all plans. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_plans_serialize( + model_id=model_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningPlansDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def planning_plans_without_preload_content( + self, + model_id: Annotated[StrictStr, Field(description="The ID of the planning model to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the plans to retrieve. Default is all plans.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of plans by planning model ID + + Retrieve all the plans you have access to for a planning model. + + :param model_id: The ID of the planning model to retrieve. (required) + :type model_id: str + :param id: The IDs of the plans to retrieve. Default is all plans. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._planning_plans_serialize( + model_id=model_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPlanningPlansDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _planning_plans_serialize( + self, + model_id, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if model_id is not None: + _path_params['modelId'] = model_id + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/plan-models/{modelId}/plans', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def prediction( + self, + id: Annotated[StrictStr, Field(description="The ID of the prediction to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelPredictionDTO: + """Retrieve a prediction by ID + + If you know the ID of a prediction, use this API to retrieve that prediction specifically. + + :param id: The ID of the prediction to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._prediction_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPredictionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def prediction_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ID of the prediction to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelPredictionDTO]: + """Retrieve a prediction by ID + + If you know the ID of a prediction, use this API to retrieve that prediction specifically. + + :param id: The ID of the prediction to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._prediction_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPredictionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def prediction_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ID of the prediction to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a prediction by ID + + If you know the ID of a prediction, use this API to retrieve that prediction specifically. + + :param id: The ID of the prediction to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._prediction_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPredictionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _prediction_serialize( + self, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/predictions/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def predictions( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the predictions to retrieve. Default is all predictions.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelPredictionsDTO: + """Retrieve a list of predictions + + Retrieve all the predictions in your Visier solution. + + :param id: The IDs of the predictions to retrieve. Default is all predictions. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._predictions_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPredictionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def predictions_with_http_info( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the predictions to retrieve. Default is all predictions.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelPredictionsDTO]: + """Retrieve a list of predictions + + Retrieve all the predictions in your Visier solution. + + :param id: The IDs of the predictions to retrieve. Default is all predictions. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._predictions_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPredictionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def predictions_without_preload_content( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the predictions to retrieve. Default is all predictions.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of predictions + + Retrieve all the predictions in your Visier solution. + + :param id: The IDs of the predictions to retrieve. Default is all predictions. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._predictions_serialize( + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPredictionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _predictions_serialize( + self, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/predictions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def properties( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the properties to retrieve. Default is all properties.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelPropertiesDTO: + """Retrieve a list of properties + + Retrieve a list of properties for a specific analytic object. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The IDs of the properties to retrieve. Default is all properties. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._properties_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPropertiesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def properties_with_http_info( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the properties to retrieve. Default is all properties.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelPropertiesDTO]: + """Retrieve a list of properties + + Retrieve a list of properties for a specific analytic object. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The IDs of the properties to retrieve. Default is all properties. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._properties_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPropertiesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def properties_without_preload_content( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the properties to retrieve. Default is all properties.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of properties + + Retrieve a list of properties for a specific analytic object. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The IDs of the properties to retrieve. Default is all properties. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._properties_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelPropertiesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _properties_serialize( + self, + object_id, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects/{objectId}/properties', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def put_properties( + self, + servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingObjectconfigurationObjectsBulkChangeResponseDTO: + """Replace properties + + Update existing properties by replacing their entire definition. The definition in your API call replaces the property's prior definition. You must provide the entire definition in the PUT call. If you omit values from the update request, those values are removed from the property. We recommend that you retrieve a property's details before you update the property with new values. This operation does not create new properties if they do not exist. In each API request, update up to 10 properties per tenant with a maximum of 500 tenants. To specify the tenant in which to update a property, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each property in the request body. To specify the project in which to update properties, provide a project UUID in the `ProjectID` request header or `projectId` for each property in the request body. + + :param servicing_objectconfiguration_properties_change_definitions_dto: (required) + :type servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_properties_serialize( + servicing_objectconfiguration_properties_change_definitions_dto=servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_properties_with_http_info( + self, + servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingObjectconfigurationObjectsBulkChangeResponseDTO]: + """Replace properties + + Update existing properties by replacing their entire definition. The definition in your API call replaces the property's prior definition. You must provide the entire definition in the PUT call. If you omit values from the update request, those values are removed from the property. We recommend that you retrieve a property's details before you update the property with new values. This operation does not create new properties if they do not exist. In each API request, update up to 10 properties per tenant with a maximum of 500 tenants. To specify the tenant in which to update a property, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each property in the request body. To specify the project in which to update properties, provide a project UUID in the `ProjectID` request header or `projectId` for each property in the request body. + + :param servicing_objectconfiguration_properties_change_definitions_dto: (required) + :type servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_properties_serialize( + servicing_objectconfiguration_properties_change_definitions_dto=servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_properties_without_preload_content( + self, + servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Replace properties + + Update existing properties by replacing their entire definition. The definition in your API call replaces the property's prior definition. You must provide the entire definition in the PUT call. If you omit values from the update request, those values are removed from the property. We recommend that you retrieve a property's details before you update the property with new values. This operation does not create new properties if they do not exist. In each API request, update up to 10 properties per tenant with a maximum of 500 tenants. To specify the tenant in which to update a property, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each property in the request body. To specify the project in which to update properties, provide a project UUID in the `ProjectID` request header or `projectId` for each property in the request body. + + :param servicing_objectconfiguration_properties_change_definitions_dto: (required) + :type servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_properties_serialize( + servicing_objectconfiguration_properties_change_definitions_dto=servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_properties_serialize( + self, + servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_objectconfiguration_properties_change_definitions_dto is not None: + _body_params = servicing_objectconfiguration_properties_change_definitions_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/data/model/properties', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def put_vee_sample_questions( + self, + servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingVeeQuestionsBulkChangeResponseDTO: + """Update Vee sample questions + + Update existing sample questions, such as its question category or whether the question is visible in Vee. Administrating tenants can specify the tenant in which to update sample questions using the `TargetTenantID` header. When updating sample questions, the question definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values for optional fields from the update request, the values reset to their respective default value. We recommend that you retrieve a question's details before you update the question with new values.
**Note:** 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). + + :param servicing_vee_questions_change_definitions_dto: (required) + :type servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_vee_sample_questions_serialize( + servicing_vee_questions_change_definitions_dto=servicing_vee_questions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_vee_sample_questions_with_http_info( + self, + servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingVeeQuestionsBulkChangeResponseDTO]: + """Update Vee sample questions + + Update existing sample questions, such as its question category or whether the question is visible in Vee. Administrating tenants can specify the tenant in which to update sample questions using the `TargetTenantID` header. When updating sample questions, the question definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values for optional fields from the update request, the values reset to their respective default value. We recommend that you retrieve a question's details before you update the question with new values.
**Note:** 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). + + :param servicing_vee_questions_change_definitions_dto: (required) + :type servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_vee_sample_questions_serialize( + servicing_vee_questions_change_definitions_dto=servicing_vee_questions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_vee_sample_questions_without_preload_content( + self, + servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update Vee sample questions + + Update existing sample questions, such as its question category or whether the question is visible in Vee. Administrating tenants can specify the tenant in which to update sample questions using the `TargetTenantID` header. When updating sample questions, the question definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values for optional fields from the update request, the values reset to their respective default value. We recommend that you retrieve a question's details before you update the question with new values.
**Note:** 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). + + :param servicing_vee_questions_change_definitions_dto: (required) + :type servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_vee_sample_questions_serialize( + servicing_vee_questions_change_definitions_dto=servicing_vee_questions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_vee_sample_questions_serialize( + self, + servicing_vee_questions_change_definitions_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_vee_questions_change_definitions_dto is not None: + _body_params = servicing_vee_questions_change_definitions_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1alpha/data/model/vee/sample-questions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def selection_concept( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[StrictStr, Field(description="The ID of the selection concept to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelSelectionConceptDTO: + """Retrieve an analytic object's selection concept by ID + + If you know the ID of a selection concept, use this API to retrieve that selection concept specifically. You must also know the analytic object's ID. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The ID of the selection concept to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._selection_concept_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelSelectionConceptDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def selection_concept_with_http_info( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[StrictStr, Field(description="The ID of the selection concept to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelSelectionConceptDTO]: + """Retrieve an analytic object's selection concept by ID + + If you know the ID of a selection concept, use this API to retrieve that selection concept specifically. You must also know the analytic object's ID. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The ID of the selection concept to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._selection_concept_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelSelectionConceptDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def selection_concept_without_preload_content( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[StrictStr, Field(description="The ID of the selection concept to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an analytic object's selection concept by ID + + If you know the ID of a selection concept, use this API to retrieve that selection concept specifically. You must also know the analytic object's ID. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The ID of the selection concept to retrieve. (required) + :type id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._selection_concept_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelSelectionConceptDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _selection_concept_serialize( + self, + object_id, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if object_id is not None: + _path_params['objectId'] = object_id + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects/{objectId}/selection-concepts/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def selection_concepts( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the selection concepts to retrieve. Default is all selection concepts.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesDatamodelSelectionConceptsDTO: + """Retrieve an analytic object's selection concepts + + Retrieve a list of selection concepts for a specific analytic object. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The IDs of the selection concepts to retrieve. Default is all selection concepts. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._selection_concepts_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelSelectionConceptsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def selection_concepts_with_http_info( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the selection concepts to retrieve. Default is all selection concepts.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesDatamodelSelectionConceptsDTO]: + """Retrieve an analytic object's selection concepts + + Retrieve a list of selection concepts for a specific analytic object. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The IDs of the selection concepts to retrieve. Default is all selection concepts. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._selection_concepts_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelSelectionConceptsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def selection_concepts_without_preload_content( + self, + object_id: Annotated[StrictStr, Field(description="The ID of the analytic object to retrieve.")], + id: Annotated[Optional[List[StrictStr]], Field(description="The IDs of the selection concepts to retrieve. Default is all selection concepts.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an analytic object's selection concepts + + Retrieve a list of selection concepts for a specific analytic object. + + :param object_id: The ID of the analytic object to retrieve. (required) + :type object_id: str + :param id: The IDs of the selection concepts to retrieve. Default is all selection concepts. + :type id: List[str] + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._selection_concepts_serialize( + object_id=object_id, + id=id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesDatamodelSelectionConceptsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _selection_concepts_serialize( + self, + object_id, + id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if object_id is not None: + _path_params['objectId'] = object_id + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/model/analytic-objects/{objectId}/selection-concepts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_analytic_objects( + self, + servicing_v2_objectconfiguration_analytic_object_request_dto: ServicingV2ObjectconfigurationAnalyticObjectRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingV2ObjectconfigurationBulkChangeResponseDTO: + """Update analytic objects + + Update the details of an analytic object. Supports reverting subjects, events, and internal comparisons to Blueprint. You can revert tenant override objects to Blueprint. If you execute the `revertToBP` operation on a: - Blueprint object: Nothing happens. The object is already the Blueprint version! - Tenant override object: The object reverts to the Blueprint version or, for administrating tenants who revert an analytic tenant's object, the administrating tenant's object version. - Tenant object: The API request fails. The object is unique to your tenant and no Blueprint version exists.
**Note:** 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). + + :param servicing_v2_objectconfiguration_analytic_object_request_dto: (required) + :type servicing_v2_objectconfiguration_analytic_object_request_dto: ServicingV2ObjectconfigurationAnalyticObjectRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_analytic_objects_serialize( + servicing_v2_objectconfiguration_analytic_object_request_dto=servicing_v2_objectconfiguration_analytic_object_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_analytic_objects_with_http_info( + self, + servicing_v2_objectconfiguration_analytic_object_request_dto: ServicingV2ObjectconfigurationAnalyticObjectRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingV2ObjectconfigurationBulkChangeResponseDTO]: + """Update analytic objects + + Update the details of an analytic object. Supports reverting subjects, events, and internal comparisons to Blueprint. You can revert tenant override objects to Blueprint. If you execute the `revertToBP` operation on a: - Blueprint object: Nothing happens. The object is already the Blueprint version! - Tenant override object: The object reverts to the Blueprint version or, for administrating tenants who revert an analytic tenant's object, the administrating tenant's object version. - Tenant object: The API request fails. The object is unique to your tenant and no Blueprint version exists.
**Note:** 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). + + :param servicing_v2_objectconfiguration_analytic_object_request_dto: (required) + :type servicing_v2_objectconfiguration_analytic_object_request_dto: ServicingV2ObjectconfigurationAnalyticObjectRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_analytic_objects_serialize( + servicing_v2_objectconfiguration_analytic_object_request_dto=servicing_v2_objectconfiguration_analytic_object_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_analytic_objects_without_preload_content( + self, + servicing_v2_objectconfiguration_analytic_object_request_dto: ServicingV2ObjectconfigurationAnalyticObjectRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update analytic objects + + Update the details of an analytic object. Supports reverting subjects, events, and internal comparisons to Blueprint. You can revert tenant override objects to Blueprint. If you execute the `revertToBP` operation on a: - Blueprint object: Nothing happens. The object is already the Blueprint version! - Tenant override object: The object reverts to the Blueprint version or, for administrating tenants who revert an analytic tenant's object, the administrating tenant's object version. - Tenant object: The API request fails. The object is unique to your tenant and no Blueprint version exists.
**Note:** 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). + + :param servicing_v2_objectconfiguration_analytic_object_request_dto: (required) + :type servicing_v2_objectconfiguration_analytic_object_request_dto: ServicingV2ObjectconfigurationAnalyticObjectRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_analytic_objects_serialize( + servicing_v2_objectconfiguration_analytic_object_request_dto=servicing_v2_objectconfiguration_analytic_object_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingV2ObjectconfigurationBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_analytic_objects_serialize( + self, + servicing_v2_objectconfiguration_analytic_object_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_v2_objectconfiguration_analytic_object_request_dto is not None: + _body_params = servicing_v2_objectconfiguration_analytic_object_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v2alpha/data/model/analytic-objects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_dimensions( + self, + servicing_objectconfiguration_dimensions_change_definitions_dto: ServicingObjectconfigurationDimensionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingObjectconfigurationObjectsBulkChangeResponseDTO: + """Update dimensions + + Change the display name, short display name, and description of one or more dimensions. This API supports updating leveled dimensions. In each API request, update up to 10 dimensions per tenant with a maximum of 500 tenants. + + :param servicing_objectconfiguration_dimensions_change_definitions_dto: (required) + :type servicing_objectconfiguration_dimensions_change_definitions_dto: ServicingObjectconfigurationDimensionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_dimensions_serialize( + servicing_objectconfiguration_dimensions_change_definitions_dto=servicing_objectconfiguration_dimensions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_dimensions_with_http_info( + self, + servicing_objectconfiguration_dimensions_change_definitions_dto: ServicingObjectconfigurationDimensionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingObjectconfigurationObjectsBulkChangeResponseDTO]: + """Update dimensions + + Change the display name, short display name, and description of one or more dimensions. This API supports updating leveled dimensions. In each API request, update up to 10 dimensions per tenant with a maximum of 500 tenants. + + :param servicing_objectconfiguration_dimensions_change_definitions_dto: (required) + :type servicing_objectconfiguration_dimensions_change_definitions_dto: ServicingObjectconfigurationDimensionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_dimensions_serialize( + servicing_objectconfiguration_dimensions_change_definitions_dto=servicing_objectconfiguration_dimensions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_dimensions_without_preload_content( + self, + servicing_objectconfiguration_dimensions_change_definitions_dto: ServicingObjectconfigurationDimensionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update dimensions + + Change the display name, short display name, and description of one or more dimensions. This API supports updating leveled dimensions. In each API request, update up to 10 dimensions per tenant with a maximum of 500 tenants. + + :param servicing_objectconfiguration_dimensions_change_definitions_dto: (required) + :type servicing_objectconfiguration_dimensions_change_definitions_dto: ServicingObjectconfigurationDimensionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_dimensions_serialize( + servicing_objectconfiguration_dimensions_change_definitions_dto=servicing_objectconfiguration_dimensions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_dimensions_serialize( + self, + servicing_objectconfiguration_dimensions_change_definitions_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_objectconfiguration_dimensions_change_definitions_dto is not None: + _body_params = servicing_objectconfiguration_dimensions_change_definitions_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/v1/data/model/dimensions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_properties( + self, + servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingObjectconfigurationObjectsBulkChangeResponseDTO: + """Update properties + + Change the display name, short display name, and description of one or more properties. In each API request, update up to 10 properties per tenant with a maximum of 500 tenants. + + :param servicing_objectconfiguration_properties_change_definitions_dto: (required) + :type servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_properties_serialize( + servicing_objectconfiguration_properties_change_definitions_dto=servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_properties_with_http_info( + self, + servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingObjectconfigurationObjectsBulkChangeResponseDTO]: + """Update properties + + Change the display name, short display name, and description of one or more properties. In each API request, update up to 10 properties per tenant with a maximum of 500 tenants. + + :param servicing_objectconfiguration_properties_change_definitions_dto: (required) + :type servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_properties_serialize( + servicing_objectconfiguration_properties_change_definitions_dto=servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_properties_without_preload_content( + self, + servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update properties + + Change the display name, short display name, and description of one or more properties. In each API request, update up to 10 properties per tenant with a maximum of 500 tenants. + + :param servicing_objectconfiguration_properties_change_definitions_dto: (required) + :type servicing_objectconfiguration_properties_change_definitions_dto: ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_properties_serialize( + servicing_objectconfiguration_properties_change_definitions_dto=servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingObjectconfigurationObjectsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_properties_serialize( + self, + servicing_objectconfiguration_properties_change_definitions_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_objectconfiguration_properties_change_definitions_dto is not None: + _body_params = servicing_objectconfiguration_properties_change_definitions_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/v1/data/model/properties', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_vee_sample_questions( + self, + servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingVeeQuestionsBulkChangeResponseDTO: + """Patch Vee sample questions + + Make partial changes to Vee sample questions. Administrating tenants can specify the tenant in which to patch questions using the `TargetTenantID` header. Unlike a `PUT` call, which completely replaces the sample question definition, use `PATCH` to change specific fields in the question without affecting omitted fields.
**Note:** 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). + + :param servicing_vee_questions_change_definitions_dto: (required) + :type servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_vee_sample_questions_serialize( + servicing_vee_questions_change_definitions_dto=servicing_vee_questions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_vee_sample_questions_with_http_info( + self, + servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingVeeQuestionsBulkChangeResponseDTO]: + """Patch Vee sample questions + + Make partial changes to Vee sample questions. Administrating tenants can specify the tenant in which to patch questions using the `TargetTenantID` header. Unlike a `PUT` call, which completely replaces the sample question definition, use `PATCH` to change specific fields in the question without affecting omitted fields.
**Note:** 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). + + :param servicing_vee_questions_change_definitions_dto: (required) + :type servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_vee_sample_questions_serialize( + servicing_vee_questions_change_definitions_dto=servicing_vee_questions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_vee_sample_questions_without_preload_content( + self, + servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch Vee sample questions + + Make partial changes to Vee sample questions. Administrating tenants can specify the tenant in which to patch questions using the `TargetTenantID` header. Unlike a `PUT` call, which completely replaces the sample question definition, use `PATCH` to change specific fields in the question without affecting omitted fields.
**Note:** 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). + + :param servicing_vee_questions_change_definitions_dto: (required) + :type servicing_vee_questions_change_definitions_dto: ServicingVeeQuestionsChangeDefinitionsDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_vee_sample_questions_serialize( + servicing_vee_questions_change_definitions_dto=servicing_vee_questions_change_definitions_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingVeeQuestionsBulkChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_vee_sample_questions_serialize( + self, + servicing_vee_questions_change_definitions_dto, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_vee_questions_change_definitions_dto is not None: + _body_params = servicing_vee_questions_change_definitions_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/v1alpha/data/model/vee/sample-questions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/data_query_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/data_query_api.py new file mode 100644 index 0000000000..c7eecf3605 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/data_query_api.py @@ -0,0 +1,1226 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.data_out_list_response import DataOutListResponse +from visier_platform_sdk.models.dataservices_query_aggregation_query_execution_dto import DataservicesQueryAggregationQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_cell_set_or_error_dto import DataservicesQueryCellSetOrErrorDTO +from visier_platform_sdk.models.dataservices_query_list_query_execution_dto import DataservicesQueryListQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_snapshot_query_execution_dto import DataservicesQuerySnapshotQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_sql_like_query_execution_dto import DataservicesQuerySqlLikeQueryExecutionDTO +from visier_platform_sdk.models.sql_like200_response import SqlLike200Response + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class DataQueryApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def aggregate( + self, + dataservices_query_aggregation_query_execution_dto: DataservicesQueryAggregationQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataservicesQueryCellSetOrErrorDTO: + """Query aggregate data + + To retrieve aggregated values from your data in Visier, you can perform an aggregation. Usually, an aggregation retrieves values over a period of time, such as multiple months. You can also group and filter your data in an aggregation query to retrieve detailed information. + + :param dataservices_query_aggregation_query_execution_dto: (required) + :type dataservices_query_aggregation_query_execution_dto: DataservicesQueryAggregationQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._aggregate_serialize( + dataservices_query_aggregation_query_execution_dto=dataservices_query_aggregation_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesQueryCellSetOrErrorDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def aggregate_with_http_info( + self, + dataservices_query_aggregation_query_execution_dto: DataservicesQueryAggregationQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataservicesQueryCellSetOrErrorDTO]: + """Query aggregate data + + To retrieve aggregated values from your data in Visier, you can perform an aggregation. Usually, an aggregation retrieves values over a period of time, such as multiple months. You can also group and filter your data in an aggregation query to retrieve detailed information. + + :param dataservices_query_aggregation_query_execution_dto: (required) + :type dataservices_query_aggregation_query_execution_dto: DataservicesQueryAggregationQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._aggregate_serialize( + dataservices_query_aggregation_query_execution_dto=dataservices_query_aggregation_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesQueryCellSetOrErrorDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def aggregate_without_preload_content( + self, + dataservices_query_aggregation_query_execution_dto: DataservicesQueryAggregationQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Query aggregate data + + To retrieve aggregated values from your data in Visier, you can perform an aggregation. Usually, an aggregation retrieves values over a period of time, such as multiple months. You can also group and filter your data in an aggregation query to retrieve detailed information. + + :param dataservices_query_aggregation_query_execution_dto: (required) + :type dataservices_query_aggregation_query_execution_dto: DataservicesQueryAggregationQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._aggregate_serialize( + dataservices_query_aggregation_query_execution_dto=dataservices_query_aggregation_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataservicesQueryCellSetOrErrorDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _aggregate_serialize( + self, + dataservices_query_aggregation_query_execution_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if dataservices_query_aggregation_query_execution_dto is not None: + _body_params = dataservices_query_aggregation_query_execution_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'application/jsonlines', + 'text/csv' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/data/query/aggregate', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list( + self, + dataservices_query_list_query_execution_dto: DataservicesQueryListQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataOutListResponse: + """Query a list of details + + To retrieve a list of values for specific objects, you can perform a list query. A list query provides information about values for selected data points, and is not an aggregated value. In Visier's interface, a list query is comparable to View Details for a specific data point in a visualization. + + :param dataservices_query_list_query_execution_dto: (required) + :type dataservices_query_list_query_execution_dto: DataservicesQueryListQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize( + dataservices_query_list_query_execution_dto=dataservices_query_list_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataOutListResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_with_http_info( + self, + dataservices_query_list_query_execution_dto: DataservicesQueryListQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataOutListResponse]: + """Query a list of details + + To retrieve a list of values for specific objects, you can perform a list query. A list query provides information about values for selected data points, and is not an aggregated value. In Visier's interface, a list query is comparable to View Details for a specific data point in a visualization. + + :param dataservices_query_list_query_execution_dto: (required) + :type dataservices_query_list_query_execution_dto: DataservicesQueryListQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize( + dataservices_query_list_query_execution_dto=dataservices_query_list_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataOutListResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_without_preload_content( + self, + dataservices_query_list_query_execution_dto: DataservicesQueryListQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Query a list of details + + To retrieve a list of values for specific objects, you can perform a list query. A list query provides information about values for selected data points, and is not an aggregated value. In Visier's interface, a list query is comparable to View Details for a specific data point in a visualization. + + :param dataservices_query_list_query_execution_dto: (required) + :type dataservices_query_list_query_execution_dto: DataservicesQueryListQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize( + dataservices_query_list_query_execution_dto=dataservices_query_list_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataOutListResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_serialize( + self, + dataservices_query_list_query_execution_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if dataservices_query_list_query_execution_dto is not None: + _body_params = dataservices_query_list_query_execution_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'application/jsonlines', + 'text/csv' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/data/query/list', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def query_snapshot( + self, + dataservices_query_snapshot_query_execution_dto: DataservicesQuerySnapshotQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DataOutListResponse: + """Query a series of detailed snapshots + + To retrieve a collection of `list` query-style snapshots taken at the defined intervals, execute a `snapshot` query. Each snapshot in the result is associated with a timestamp, or the \"effective date\" at which date snapshot data was valid. This API allows you to request a detailed time series from Visier. Structurally, a `snapshot` query is similar to a `list` query, but has the following differences: * The `snapshot` query may contain a column, `effectiveDateProperty`, that specifies the time for each snapshot. To include the `effectiveDateProperty` column, add the following object to the columns array: ```json { \"columnName\": \"Snapshot_Date\", \"columnDefinition\": { \"effectiveDateProperty\": {} } } ``` * The `snapshot` query uses `timeIntervals` (like an `aggregate` query) instead of `timeInterval` (like a `list` query) because the `snapshot` query must specify the number of snapshots to generate. To specify the number of snapshots to generate, use the `intervalCount` property in the `timeIntervals` object, as shown next. ```json { \"timeIntervals\": { \"fromDateTime\": \"2022-01-01\", \"intervalPeriodType\": \"MONTH\", \"intervalPeriodCount\": 6, \"intervalCount\": 4 } ``` + + :param dataservices_query_snapshot_query_execution_dto: (required) + :type dataservices_query_snapshot_query_execution_dto: DataservicesQuerySnapshotQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._query_snapshot_serialize( + dataservices_query_snapshot_query_execution_dto=dataservices_query_snapshot_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataOutListResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def query_snapshot_with_http_info( + self, + dataservices_query_snapshot_query_execution_dto: DataservicesQuerySnapshotQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DataOutListResponse]: + """Query a series of detailed snapshots + + To retrieve a collection of `list` query-style snapshots taken at the defined intervals, execute a `snapshot` query. Each snapshot in the result is associated with a timestamp, or the \"effective date\" at which date snapshot data was valid. This API allows you to request a detailed time series from Visier. Structurally, a `snapshot` query is similar to a `list` query, but has the following differences: * The `snapshot` query may contain a column, `effectiveDateProperty`, that specifies the time for each snapshot. To include the `effectiveDateProperty` column, add the following object to the columns array: ```json { \"columnName\": \"Snapshot_Date\", \"columnDefinition\": { \"effectiveDateProperty\": {} } } ``` * The `snapshot` query uses `timeIntervals` (like an `aggregate` query) instead of `timeInterval` (like a `list` query) because the `snapshot` query must specify the number of snapshots to generate. To specify the number of snapshots to generate, use the `intervalCount` property in the `timeIntervals` object, as shown next. ```json { \"timeIntervals\": { \"fromDateTime\": \"2022-01-01\", \"intervalPeriodType\": \"MONTH\", \"intervalPeriodCount\": 6, \"intervalCount\": 4 } ``` + + :param dataservices_query_snapshot_query_execution_dto: (required) + :type dataservices_query_snapshot_query_execution_dto: DataservicesQuerySnapshotQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._query_snapshot_serialize( + dataservices_query_snapshot_query_execution_dto=dataservices_query_snapshot_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataOutListResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def query_snapshot_without_preload_content( + self, + dataservices_query_snapshot_query_execution_dto: DataservicesQuerySnapshotQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Query a series of detailed snapshots + + To retrieve a collection of `list` query-style snapshots taken at the defined intervals, execute a `snapshot` query. Each snapshot in the result is associated with a timestamp, or the \"effective date\" at which date snapshot data was valid. This API allows you to request a detailed time series from Visier. Structurally, a `snapshot` query is similar to a `list` query, but has the following differences: * The `snapshot` query may contain a column, `effectiveDateProperty`, that specifies the time for each snapshot. To include the `effectiveDateProperty` column, add the following object to the columns array: ```json { \"columnName\": \"Snapshot_Date\", \"columnDefinition\": { \"effectiveDateProperty\": {} } } ``` * The `snapshot` query uses `timeIntervals` (like an `aggregate` query) instead of `timeInterval` (like a `list` query) because the `snapshot` query must specify the number of snapshots to generate. To specify the number of snapshots to generate, use the `intervalCount` property in the `timeIntervals` object, as shown next. ```json { \"timeIntervals\": { \"fromDateTime\": \"2022-01-01\", \"intervalPeriodType\": \"MONTH\", \"intervalPeriodCount\": 6, \"intervalCount\": 4 } ``` + + :param dataservices_query_snapshot_query_execution_dto: (required) + :type dataservices_query_snapshot_query_execution_dto: DataservicesQuerySnapshotQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._query_snapshot_serialize( + dataservices_query_snapshot_query_execution_dto=dataservices_query_snapshot_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DataOutListResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _query_snapshot_serialize( + self, + dataservices_query_snapshot_query_execution_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if dataservices_query_snapshot_query_execution_dto is not None: + _body_params = dataservices_query_snapshot_query_execution_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'application/jsonlines', + 'text/csv' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/data/query/snapshot', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def sql_like( + self, + dataservices_query_sql_like_query_execution_dto: DataservicesQuerySqlLikeQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SqlLike200Response: + """Query aggregate or list data using SQL-like syntax + + To retrieve a list of values for specific objects or aggregate values from metrics, you can write queries using SQL-like syntax. The response format matches the query type whether aggregate or list. If requested, aggregate query results may be flattened into tabular format. A SQL-like query is an aggregate if it contains at least one metric. Aggregate queries must specify a time interval divided into periods; for example: ```sql SELECT employeeCount() AS \"Employee Count\", level(Gender, \"Gender\") AS Gender FROM Employee WHERE Visier_Time IN periods(date(\"2023-01-01\"), 4, period(3, Month)); ``` A SQL-like query is a list if it does not contain any metrics. List queries define time intervals as simple intervals; for example: ```sql SELECT EmployeeID AS \"Employee ID\", level(Gender, \"Gender\") AS Gender FROM Employee WHERE Visier_Time BETWEEN date(\"2022-01-01\") AND date(\"2023-01-01\"); ``` + + :param dataservices_query_sql_like_query_execution_dto: (required) + :type dataservices_query_sql_like_query_execution_dto: DataservicesQuerySqlLikeQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._sql_like_serialize( + dataservices_query_sql_like_query_execution_dto=dataservices_query_sql_like_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SqlLike200Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def sql_like_with_http_info( + self, + dataservices_query_sql_like_query_execution_dto: DataservicesQuerySqlLikeQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SqlLike200Response]: + """Query aggregate or list data using SQL-like syntax + + To retrieve a list of values for specific objects or aggregate values from metrics, you can write queries using SQL-like syntax. The response format matches the query type whether aggregate or list. If requested, aggregate query results may be flattened into tabular format. A SQL-like query is an aggregate if it contains at least one metric. Aggregate queries must specify a time interval divided into periods; for example: ```sql SELECT employeeCount() AS \"Employee Count\", level(Gender, \"Gender\") AS Gender FROM Employee WHERE Visier_Time IN periods(date(\"2023-01-01\"), 4, period(3, Month)); ``` A SQL-like query is a list if it does not contain any metrics. List queries define time intervals as simple intervals; for example: ```sql SELECT EmployeeID AS \"Employee ID\", level(Gender, \"Gender\") AS Gender FROM Employee WHERE Visier_Time BETWEEN date(\"2022-01-01\") AND date(\"2023-01-01\"); ``` + + :param dataservices_query_sql_like_query_execution_dto: (required) + :type dataservices_query_sql_like_query_execution_dto: DataservicesQuerySqlLikeQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._sql_like_serialize( + dataservices_query_sql_like_query_execution_dto=dataservices_query_sql_like_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SqlLike200Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def sql_like_without_preload_content( + self, + dataservices_query_sql_like_query_execution_dto: DataservicesQuerySqlLikeQueryExecutionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Query aggregate or list data using SQL-like syntax + + To retrieve a list of values for specific objects or aggregate values from metrics, you can write queries using SQL-like syntax. The response format matches the query type whether aggregate or list. If requested, aggregate query results may be flattened into tabular format. A SQL-like query is an aggregate if it contains at least one metric. Aggregate queries must specify a time interval divided into periods; for example: ```sql SELECT employeeCount() AS \"Employee Count\", level(Gender, \"Gender\") AS Gender FROM Employee WHERE Visier_Time IN periods(date(\"2023-01-01\"), 4, period(3, Month)); ``` A SQL-like query is a list if it does not contain any metrics. List queries define time intervals as simple intervals; for example: ```sql SELECT EmployeeID AS \"Employee ID\", level(Gender, \"Gender\") AS Gender FROM Employee WHERE Visier_Time BETWEEN date(\"2022-01-01\") AND date(\"2023-01-01\"); ``` + + :param dataservices_query_sql_like_query_execution_dto: (required) + :type dataservices_query_sql_like_query_execution_dto: DataservicesQuerySqlLikeQueryExecutionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._sql_like_serialize( + dataservices_query_sql_like_query_execution_dto=dataservices_query_sql_like_query_execution_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SqlLike200Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _sql_like_serialize( + self, + dataservices_query_sql_like_query_execution_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if dataservices_query_sql_like_query_execution_dto is not None: + _body_params = dataservices_query_sql_like_query_execution_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'application/jsonlines', + 'text/csv' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/data/query/sql', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/data_upload_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/data_upload_api.py new file mode 100644 index 0000000000..a305c7a987 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/data_upload_api.py @@ -0,0 +1,343 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBytes, StrictStr +from typing import Optional, Tuple, Union +from typing_extensions import Annotated +from visier_platform_sdk.models.status import Status + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class DataUploadApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def file_upload( + self, + filename: Annotated[StrictStr, Field(description="The filename of the data file to upload, including the file extension (such as .zip or .csv).")], + 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, + body: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> Status: + """Upload a data file to Visier + + Use this API to upload data files to Visier. You can upload ZIP, CSV, XLS, and XLSX filetypes in plaintext or encrypted with Visier's PGP key. Use of this API requires client redirect. This API redirects requests directly to Visier's upload infrastructure to support long-running uploads. To ensure efficient uploading, we recommend that you use an HTTP client that supports the 100 Continue status code. The maximum file upload size is 500 MB. We recommend using SFTP for larger file sizes. + + :param filename: The filename of the data file to upload, including the file extension (such as .zip or .csv). (required) + :type filename: str + :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. + :type target_tenant_id: str + :param body: + :type body: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._file_upload_serialize( + filename=filename, + target_tenant_id=target_tenant_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '307': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def file_upload_with_http_info( + self, + filename: Annotated[StrictStr, Field(description="The filename of the data file to upload, including the file extension (such as .zip or .csv).")], + 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, + body: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[Status]: + """Upload a data file to Visier + + Use this API to upload data files to Visier. You can upload ZIP, CSV, XLS, and XLSX filetypes in plaintext or encrypted with Visier's PGP key. Use of this API requires client redirect. This API redirects requests directly to Visier's upload infrastructure to support long-running uploads. To ensure efficient uploading, we recommend that you use an HTTP client that supports the 100 Continue status code. The maximum file upload size is 500 MB. We recommend using SFTP for larger file sizes. + + :param filename: The filename of the data file to upload, including the file extension (such as .zip or .csv). (required) + :type filename: str + :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. + :type target_tenant_id: str + :param body: + :type body: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._file_upload_serialize( + filename=filename, + target_tenant_id=target_tenant_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '307': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def file_upload_without_preload_content( + self, + filename: Annotated[StrictStr, Field(description="The filename of the data file to upload, including the file extension (such as .zip or .csv).")], + 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, + body: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Upload a data file to Visier + + Use this API to upload data files to Visier. You can upload ZIP, CSV, XLS, and XLSX filetypes in plaintext or encrypted with Visier's PGP key. Use of this API requires client redirect. This API redirects requests directly to Visier's upload infrastructure to support long-running uploads. To ensure efficient uploading, we recommend that you use an HTTP client that supports the 100 Continue status code. The maximum file upload size is 500 MB. We recommend using SFTP for larger file sizes. + + :param filename: The filename of the data file to upload, including the file extension (such as .zip or .csv). (required) + :type filename: str + :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. + :type target_tenant_id: str + :param body: + :type body: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._file_upload_serialize( + filename=filename, + target_tenant_id=target_tenant_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '307': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _file_upload_serialize( + self, + filename, + target_tenant_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if filename is not None: + _path_params['filename'] = filename + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if body is not None: + # convert to byte array if the input is a file name (str) + if isinstance(body, str): + with open(body, "rb") as _fp: + _body_params = _fp.read() + elif isinstance(body, tuple): + # drop the filename from the tuple + _body_params = body[1] + else: + _body_params = body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/data/upload/files/{filename}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/data_version_export_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/data_version_export_api.py new file mode 100644 index 0000000000..1f2df2f74b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/data_version_export_api.py @@ -0,0 +1,1724 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBytes, StrictInt, StrictStr +from typing import Optional, Tuple, Union +from typing_extensions import Annotated +from visier_platform_sdk.models.designer_data_version_export_dto import DesignerDataVersionExportDTO +from visier_platform_sdk.models.designer_data_version_export_data_versions_dto import DesignerDataVersionExportDataVersionsDTO +from visier_platform_sdk.models.designer_data_version_export_job_status_dto import DesignerDataVersionExportJobStatusDTO +from visier_platform_sdk.models.designer_data_version_export_schedule_job_request_dto import DesignerDataVersionExportScheduleJobRequestDTO +from visier_platform_sdk.models.designer_data_version_export_schedule_job_response_dto import DesignerDataVersionExportScheduleJobResponseDTO +from visier_platform_sdk.models.designer_data_version_exports_dto import DesignerDataVersionExportsDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class DataVersionExportApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def call_1_alpha_download_file( + self, + export_uuid: Annotated[StrictStr, Field(description="The unique identifier of the data version export.")], + file_id: Annotated[StrictInt, Field(description="The unique integer identifier of the file within the data version export.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Download a file from a data version export + + This API allows you to download a file from a data version export. Data version export files are in CSV format, compressed with gzip. + + :param export_uuid: The unique identifier of the data version export. (required) + :type export_uuid: str + :param file_id: The unique integer identifier of the file within the data version export. (required) + :type file_id: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._call_1_alpha_download_file_serialize( + export_uuid=export_uuid, + file_id=file_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def call_1_alpha_download_file_with_http_info( + self, + export_uuid: Annotated[StrictStr, Field(description="The unique identifier of the data version export.")], + file_id: Annotated[StrictInt, Field(description="The unique integer identifier of the file within the data version export.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Download a file from a data version export + + This API allows you to download a file from a data version export. Data version export files are in CSV format, compressed with gzip. + + :param export_uuid: The unique identifier of the data version export. (required) + :type export_uuid: str + :param file_id: The unique integer identifier of the file within the data version export. (required) + :type file_id: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._call_1_alpha_download_file_serialize( + export_uuid=export_uuid, + file_id=file_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def call_1_alpha_download_file_without_preload_content( + self, + export_uuid: Annotated[StrictStr, Field(description="The unique identifier of the data version export.")], + file_id: Annotated[StrictInt, Field(description="The unique integer identifier of the file within the data version export.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Download a file from a data version export + + This API allows you to download a file from a data version export. Data version export files are in CSV format, compressed with gzip. + + :param export_uuid: The unique identifier of the data version export. (required) + :type export_uuid: str + :param file_id: The unique integer identifier of the file within the data version export. (required) + :type file_id: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._call_1_alpha_download_file_serialize( + export_uuid=export_uuid, + file_id=file_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _call_1_alpha_download_file_serialize( + self, + export_uuid, + file_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if export_uuid is not None: + _path_params['exportUuid'] = export_uuid + if file_id is not None: + _path_params['fileId'] = file_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/gzip', + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/data/data-version-exports/exports/{exportUuid}/files/{fileId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_available_data_versions( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerDataVersionExportDataVersionsDTO: + """Retrieve a list of all data versions + + Retrieve a list of all data versions in the tenant. **Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_available_data_versions_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportDataVersionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_available_data_versions_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerDataVersionExportDataVersionsDTO]: + """Retrieve a list of all data versions + + Retrieve a list of all data versions in the tenant. **Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_available_data_versions_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportDataVersionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_available_data_versions_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all data versions + + Retrieve a list of all data versions in the tenant. **Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_available_data_versions_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportDataVersionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_available_data_versions_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/data/data-version-exports/data-versions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_available_exports( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerDataVersionExportsDTO: + """Retrieve the details of all data version exports + + Retrieve the information for all available data version exports. **Note:** Data version exports are available for 14 days after export job completes. **Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_available_exports_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_available_exports_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerDataVersionExportsDTO]: + """Retrieve the details of all data version exports + + Retrieve the information for all available data version exports. **Note:** Data version exports are available for 14 days after export job completes. **Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_available_exports_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_available_exports_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the details of all data version exports + + Retrieve the information for all available data version exports. **Note:** Data version exports are available for 14 days after export job completes. **Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_available_exports_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_available_exports_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/data/data-version-exports/exports', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_export( + self, + export_uuid: Annotated[StrictStr, Field(description="The unique identifier of the data version export.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerDataVersionExportDTO: + """Retrieve the details of a data version export + + Retrieve information for a specific data version export. **Note:** Data version exports are available for 14 days after export job completes. **Note:** 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). + + :param export_uuid: The unique identifier of the data version export. (required) + :type export_uuid: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_serialize( + export_uuid=export_uuid, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_export_with_http_info( + self, + export_uuid: Annotated[StrictStr, Field(description="The unique identifier of the data version export.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerDataVersionExportDTO]: + """Retrieve the details of a data version export + + Retrieve information for a specific data version export. **Note:** Data version exports are available for 14 days after export job completes. **Note:** 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). + + :param export_uuid: The unique identifier of the data version export. (required) + :type export_uuid: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_serialize( + export_uuid=export_uuid, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_export_without_preload_content( + self, + export_uuid: Annotated[StrictStr, Field(description="The unique identifier of the data version export.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the details of a data version export + + Retrieve information for a specific data version export. **Note:** Data version exports are available for 14 days after export job completes. **Note:** 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). + + :param export_uuid: The unique identifier of the data version export. (required) + :type export_uuid: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_serialize( + export_uuid=export_uuid, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_export_serialize( + self, + export_uuid, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if export_uuid is not None: + _path_params['exportUuid'] = export_uuid + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/data/data-version-exports/exports/{exportUuid}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_export_job_status( + self, + job_uuid: Annotated[StrictStr, Field(description="The unique identifier of the data version export job.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerDataVersionExportJobStatusDTO: + """Retrieve a data version export job's status + + Retrieve the status of a data version export job. After the job completes successfully, this endpoint returns an `exportUuid` that you can use to retrieve the export information and download export files. **Note:** 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). + + :param job_uuid: The unique identifier of the data version export job. (required) + :type job_uuid: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_job_status_serialize( + job_uuid=job_uuid, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportJobStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_export_job_status_with_http_info( + self, + job_uuid: Annotated[StrictStr, Field(description="The unique identifier of the data version export job.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerDataVersionExportJobStatusDTO]: + """Retrieve a data version export job's status + + Retrieve the status of a data version export job. After the job completes successfully, this endpoint returns an `exportUuid` that you can use to retrieve the export information and download export files. **Note:** 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). + + :param job_uuid: The unique identifier of the data version export job. (required) + :type job_uuid: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_job_status_serialize( + job_uuid=job_uuid, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportJobStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_export_job_status_without_preload_content( + self, + job_uuid: Annotated[StrictStr, Field(description="The unique identifier of the data version export job.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a data version export job's status + + Retrieve the status of a data version export job. After the job completes successfully, this endpoint returns an `exportUuid` that you can use to retrieve the export information and download export files. **Note:** 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). + + :param job_uuid: The unique identifier of the data version export job. (required) + :type job_uuid: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_export_job_status_serialize( + job_uuid=job_uuid, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportJobStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_export_job_status_serialize( + self, + job_uuid, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if job_uuid is not None: + _path_params['jobUuid'] = job_uuid + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/data/data-version-exports/jobs/{jobUuid}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def schedule_export_job( + self, + designer_data_version_export_schedule_job_request_dto: DesignerDataVersionExportScheduleJobRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerDataVersionExportScheduleJobResponseDTO: + """Schedule a data version export job + + Schedule a data version export job. The job schedules immediately and will begin when resources are available. The response returns a `jobUuid` that you can use to check the export job status. **Note:** There is a limit of 10 export jobs per tenant per day. **Note:** 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). + + :param designer_data_version_export_schedule_job_request_dto: (required) + :type designer_data_version_export_schedule_job_request_dto: DesignerDataVersionExportScheduleJobRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._schedule_export_job_serialize( + designer_data_version_export_schedule_job_request_dto=designer_data_version_export_schedule_job_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportScheduleJobResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def schedule_export_job_with_http_info( + self, + designer_data_version_export_schedule_job_request_dto: DesignerDataVersionExportScheduleJobRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerDataVersionExportScheduleJobResponseDTO]: + """Schedule a data version export job + + Schedule a data version export job. The job schedules immediately and will begin when resources are available. The response returns a `jobUuid` that you can use to check the export job status. **Note:** There is a limit of 10 export jobs per tenant per day. **Note:** 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). + + :param designer_data_version_export_schedule_job_request_dto: (required) + :type designer_data_version_export_schedule_job_request_dto: DesignerDataVersionExportScheduleJobRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._schedule_export_job_serialize( + designer_data_version_export_schedule_job_request_dto=designer_data_version_export_schedule_job_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportScheduleJobResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def schedule_export_job_without_preload_content( + self, + designer_data_version_export_schedule_job_request_dto: DesignerDataVersionExportScheduleJobRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Schedule a data version export job + + Schedule a data version export job. The job schedules immediately and will begin when resources are available. The response returns a `jobUuid` that you can use to check the export job status. **Note:** There is a limit of 10 export jobs per tenant per day. **Note:** 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). + + :param designer_data_version_export_schedule_job_request_dto: (required) + :type designer_data_version_export_schedule_job_request_dto: DesignerDataVersionExportScheduleJobRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._schedule_export_job_serialize( + designer_data_version_export_schedule_job_request_dto=designer_data_version_export_schedule_job_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDataVersionExportScheduleJobResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _schedule_export_job_serialize( + self, + designer_data_version_export_schedule_job_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if designer_data_version_export_schedule_job_request_dto is not None: + _body_params = designer_data_version_export_schedule_job_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/data/data-version-exports/jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/dimensions_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/dimensions_api.py new file mode 100644 index 0000000000..f709d04205 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/dimensions_api.py @@ -0,0 +1,3050 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr +from typing import List, Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.dimension_member import DimensionMember +from visier_platform_sdk.models.hierarchy import Hierarchy +from visier_platform_sdk.models.job_feedback_input import JobFeedbackInput +from visier_platform_sdk.models.job_search_input import JobSearchInput +from visier_platform_sdk.models.job_search_output import JobSearchOutput +from visier_platform_sdk.models.job_standardization_input import JobStandardizationInput +from visier_platform_sdk.models.location_search_input import LocationSearchInput +from visier_platform_sdk.models.location_search_output import LocationSearchOutput +from visier_platform_sdk.models.output_entry import OutputEntry + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class DimensionsApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def get_career_levels( + self, + job: Annotated[Optional[StrictStr], Field(description="The job member ID. If provided, the response returns the members for the job. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DimensionMember]: + """Get career levels + + Retrieve a list of all available career levels. + + :param job: The job member ID. If provided, the response returns the members for the job. + :type job: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_career_levels_serialize( + job=job, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_career_levels_with_http_info( + self, + job: Annotated[Optional[StrictStr], Field(description="The job member ID. If provided, the response returns the members for the job. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DimensionMember]]: + """Get career levels + + Retrieve a list of all available career levels. + + :param job: The job member ID. If provided, the response returns the members for the job. + :type job: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_career_levels_serialize( + job=job, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_career_levels_without_preload_content( + self, + job: Annotated[Optional[StrictStr], Field(description="The job member ID. If provided, the response returns the members for the job. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get career levels + + Retrieve a list of all available career levels. + + :param job: The job member ID. If provided, the response returns the members for the job. + :type job: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_career_levels_serialize( + job=job, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_career_levels_serialize( + self, + job, + has_benchmark_value, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if job is not None: + + _query_params.append(('job', job)) + + if has_benchmark_value is not None: + + _query_params.append(('hasBenchmarkValue', has_benchmark_value)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/compensation-benchmarks/career-levels', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_company_sizes( + self, + headcount: Annotated[Optional[StrictInt], Field(description="The number of employees. If provided, the response returns the members with the same headcount. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DimensionMember]: + """Get company sizes + + Retrieve a list of all available company sizes. + + :param headcount: The number of employees. If provided, the response returns the members with the same headcount. + :type headcount: int + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_company_sizes_serialize( + headcount=headcount, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_company_sizes_with_http_info( + self, + headcount: Annotated[Optional[StrictInt], Field(description="The number of employees. If provided, the response returns the members with the same headcount. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DimensionMember]]: + """Get company sizes + + Retrieve a list of all available company sizes. + + :param headcount: The number of employees. If provided, the response returns the members with the same headcount. + :type headcount: int + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_company_sizes_serialize( + headcount=headcount, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_company_sizes_without_preload_content( + self, + headcount: Annotated[Optional[StrictInt], Field(description="The number of employees. If provided, the response returns the members with the same headcount. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get company sizes + + Retrieve a list of all available company sizes. + + :param headcount: The number of employees. If provided, the response returns the members with the same headcount. + :type headcount: int + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_company_sizes_serialize( + headcount=headcount, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_company_sizes_serialize( + self, + headcount, + has_benchmark_value, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if headcount is not None: + + _query_params.append(('headcount', headcount)) + + if has_benchmark_value is not None: + + _query_params.append(('hasBenchmarkValue', has_benchmark_value)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/compensation-benchmarks/company-sizes', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_industries( + self, + parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. ")] = None, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If provided, the response returns the best matching member associated with the code. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DimensionMember]: + """Get industries + + Retrieve a list of all available industries. + + :param parent: The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. + :type parent: str + :param naics_code: The North American Industry Classification System (NAICS) code. If provided, the response returns the best matching member associated with the code. + :type naics_code: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_industries_serialize( + parent=parent, + naics_code=naics_code, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_industries_with_http_info( + self, + parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. ")] = None, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If provided, the response returns the best matching member associated with the code. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DimensionMember]]: + """Get industries + + Retrieve a list of all available industries. + + :param parent: The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. + :type parent: str + :param naics_code: The North American Industry Classification System (NAICS) code. If provided, the response returns the best matching member associated with the code. + :type naics_code: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_industries_serialize( + parent=parent, + naics_code=naics_code, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_industries_without_preload_content( + self, + parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. ")] = None, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If provided, the response returns the best matching member associated with the code. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get industries + + Retrieve a list of all available industries. + + :param parent: The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. + :type parent: str + :param naics_code: The North American Industry Classification System (NAICS) code. If provided, the response returns the best matching member associated with the code. + :type naics_code: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_industries_serialize( + parent=parent, + naics_code=naics_code, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_industries_serialize( + self, + parent, + naics_code, + has_benchmark_value, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if parent is not None: + + _query_params.append(('parent', parent)) + + if naics_code is not None: + + _query_params.append(('naicsCode', naics_code)) + + if has_benchmark_value is not None: + + _query_params.append(('hasBenchmarkValue', has_benchmark_value)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/compensation-benchmarks/industries', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_job_hierarchies( + self, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If provided, the response returns the hierarchies associated with the code. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[Hierarchy]: + """Get job hierarchies + + Retrieve a list of all hierarchies used to organize jobs. + + :param naics_code: The North American Industry Classification System (NAICS) code. If provided, the response returns the hierarchies associated with the code. + :type naics_code: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_job_hierarchies_serialize( + naics_code=naics_code, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[Hierarchy]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_job_hierarchies_with_http_info( + self, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If provided, the response returns the hierarchies associated with the code. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[Hierarchy]]: + """Get job hierarchies + + Retrieve a list of all hierarchies used to organize jobs. + + :param naics_code: The North American Industry Classification System (NAICS) code. If provided, the response returns the hierarchies associated with the code. + :type naics_code: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_job_hierarchies_serialize( + naics_code=naics_code, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[Hierarchy]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_job_hierarchies_without_preload_content( + self, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If provided, the response returns the hierarchies associated with the code. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get job hierarchies + + Retrieve a list of all hierarchies used to organize jobs. + + :param naics_code: The North American Industry Classification System (NAICS) code. If provided, the response returns the hierarchies associated with the code. + :type naics_code: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_job_hierarchies_serialize( + naics_code=naics_code, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[Hierarchy]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_job_hierarchies_serialize( + self, + naics_code, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if naics_code is not None: + + _query_params.append(('naicsCode', naics_code)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/compensation-benchmarks/jobs/hierarchies', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_jobs( + self, + hierarchy: Annotated[Optional[StrictStr], Field(description="The ID of the job hierarchy to navigate. If not provided, Visier's default job hierarchy is used. In the default hierarchy, jobs are organized into three levels with domain and subdomain groupings. ")] = None, + parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. Member availability and the parent-child relationship depends on the selected hierarchy. Please refer to the `hierarchy` parameter. ")] = None, + term: Annotated[Optional[StrictStr], Field(description="The input search term. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. Your search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results. The minimum length is 3 characters and the maximum length is 100 characters. ***The search term must be URL encoded.*** ")] = None, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If `naicsCode` is provided, `term` is required. The most relevant job members associated with the naicsCode are returned first. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + semantic_only: Annotated[Optional[StrictBool], Field(description="If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None, + lexical_only: Annotated[Optional[StrictBool], Field(description="If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None, + typical_titles_search: Annotated[Optional[StrictBool], Field(description="If `true`, similar job titles for a job member are included in the lexical search for matches. Ensure the parameters 'lexicalOnly' is set to 'true' and 'semanticOnly' is set to 'false'. Default is `false`. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DimensionMember]: + """Get jobs + + Retrieve a list of all the jobs in Visier's ontology. + + :param hierarchy: The ID of the job hierarchy to navigate. If not provided, Visier's default job hierarchy is used. In the default hierarchy, jobs are organized into three levels with domain and subdomain groupings. + :type hierarchy: str + :param parent: The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. Member availability and the parent-child relationship depends on the selected hierarchy. Please refer to the `hierarchy` parameter. + :type parent: str + :param term: The input search term. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. Your search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results. The minimum length is 3 characters and the maximum length is 100 characters. ***The search term must be URL encoded.*** + :type term: str + :param naics_code: The North American Industry Classification System (NAICS) code. If `naicsCode` is provided, `term` is required. The most relevant job members associated with the naicsCode are returned first. + :type naics_code: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param semantic_only: If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. + :type semantic_only: bool + :param lexical_only: If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. + :type lexical_only: bool + :param typical_titles_search: If `true`, similar job titles for a job member are included in the lexical search for matches. Ensure the parameters 'lexicalOnly' is set to 'true' and 'semanticOnly' is set to 'false'. Default is `false`. + :type typical_titles_search: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_jobs_serialize( + hierarchy=hierarchy, + parent=parent, + term=term, + naics_code=naics_code, + has_benchmark_value=has_benchmark_value, + semantic_only=semantic_only, + lexical_only=lexical_only, + typical_titles_search=typical_titles_search, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_jobs_with_http_info( + self, + hierarchy: Annotated[Optional[StrictStr], Field(description="The ID of the job hierarchy to navigate. If not provided, Visier's default job hierarchy is used. In the default hierarchy, jobs are organized into three levels with domain and subdomain groupings. ")] = None, + parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. Member availability and the parent-child relationship depends on the selected hierarchy. Please refer to the `hierarchy` parameter. ")] = None, + term: Annotated[Optional[StrictStr], Field(description="The input search term. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. Your search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results. The minimum length is 3 characters and the maximum length is 100 characters. ***The search term must be URL encoded.*** ")] = None, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If `naicsCode` is provided, `term` is required. The most relevant job members associated with the naicsCode are returned first. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + semantic_only: Annotated[Optional[StrictBool], Field(description="If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None, + lexical_only: Annotated[Optional[StrictBool], Field(description="If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None, + typical_titles_search: Annotated[Optional[StrictBool], Field(description="If `true`, similar job titles for a job member are included in the lexical search for matches. Ensure the parameters 'lexicalOnly' is set to 'true' and 'semanticOnly' is set to 'false'. Default is `false`. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DimensionMember]]: + """Get jobs + + Retrieve a list of all the jobs in Visier's ontology. + + :param hierarchy: The ID of the job hierarchy to navigate. If not provided, Visier's default job hierarchy is used. In the default hierarchy, jobs are organized into three levels with domain and subdomain groupings. + :type hierarchy: str + :param parent: The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. Member availability and the parent-child relationship depends on the selected hierarchy. Please refer to the `hierarchy` parameter. + :type parent: str + :param term: The input search term. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. Your search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results. The minimum length is 3 characters and the maximum length is 100 characters. ***The search term must be URL encoded.*** + :type term: str + :param naics_code: The North American Industry Classification System (NAICS) code. If `naicsCode` is provided, `term` is required. The most relevant job members associated with the naicsCode are returned first. + :type naics_code: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param semantic_only: If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. + :type semantic_only: bool + :param lexical_only: If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. + :type lexical_only: bool + :param typical_titles_search: If `true`, similar job titles for a job member are included in the lexical search for matches. Ensure the parameters 'lexicalOnly' is set to 'true' and 'semanticOnly' is set to 'false'. Default is `false`. + :type typical_titles_search: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_jobs_serialize( + hierarchy=hierarchy, + parent=parent, + term=term, + naics_code=naics_code, + has_benchmark_value=has_benchmark_value, + semantic_only=semantic_only, + lexical_only=lexical_only, + typical_titles_search=typical_titles_search, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_jobs_without_preload_content( + self, + hierarchy: Annotated[Optional[StrictStr], Field(description="The ID of the job hierarchy to navigate. If not provided, Visier's default job hierarchy is used. In the default hierarchy, jobs are organized into three levels with domain and subdomain groupings. ")] = None, + parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. Member availability and the parent-child relationship depends on the selected hierarchy. Please refer to the `hierarchy` parameter. ")] = None, + term: Annotated[Optional[StrictStr], Field(description="The input search term. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. Your search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results. The minimum length is 3 characters and the maximum length is 100 characters. ***The search term must be URL encoded.*** ")] = None, + naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code. If `naicsCode` is provided, `term` is required. The most relevant job members associated with the naicsCode are returned first. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + semantic_only: Annotated[Optional[StrictBool], Field(description="If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None, + lexical_only: Annotated[Optional[StrictBool], Field(description="If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None, + typical_titles_search: Annotated[Optional[StrictBool], Field(description="If `true`, similar job titles for a job member are included in the lexical search for matches. Ensure the parameters 'lexicalOnly' is set to 'true' and 'semanticOnly' is set to 'false'. Default is `false`. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get jobs + + Retrieve a list of all the jobs in Visier's ontology. + + :param hierarchy: The ID of the job hierarchy to navigate. If not provided, Visier's default job hierarchy is used. In the default hierarchy, jobs are organized into three levels with domain and subdomain groupings. + :type hierarchy: str + :param parent: The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level members, use the value `root`. Member availability and the parent-child relationship depends on the selected hierarchy. Please refer to the `hierarchy` parameter. + :type parent: str + :param term: The input search term. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. Your search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results. The minimum length is 3 characters and the maximum length is 100 characters. ***The search term must be URL encoded.*** + :type term: str + :param naics_code: The North American Industry Classification System (NAICS) code. If `naicsCode` is provided, `term` is required. The most relevant job members associated with the naicsCode are returned first. + :type naics_code: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param semantic_only: If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. + :type semantic_only: bool + :param lexical_only: If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. + :type lexical_only: bool + :param typical_titles_search: If `true`, similar job titles for a job member are included in the lexical search for matches. Ensure the parameters 'lexicalOnly' is set to 'true' and 'semanticOnly' is set to 'false'. Default is `false`. + :type typical_titles_search: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_jobs_serialize( + hierarchy=hierarchy, + parent=parent, + term=term, + naics_code=naics_code, + has_benchmark_value=has_benchmark_value, + semantic_only=semantic_only, + lexical_only=lexical_only, + typical_titles_search=typical_titles_search, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_jobs_serialize( + self, + hierarchy, + parent, + term, + naics_code, + has_benchmark_value, + semantic_only, + lexical_only, + typical_titles_search, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if hierarchy is not None: + + _query_params.append(('hierarchy', hierarchy)) + + if parent is not None: + + _query_params.append(('parent', parent)) + + if term is not None: + + _query_params.append(('term', term)) + + if naics_code is not None: + + _query_params.append(('naicsCode', naics_code)) + + if has_benchmark_value is not None: + + _query_params.append(('hasBenchmarkValue', has_benchmark_value)) + + if semantic_only is not None: + + _query_params.append(('semanticOnly', semantic_only)) + + if lexical_only is not None: + + _query_params.append(('lexicalOnly', lexical_only)) + + if typical_titles_search is not None: + + _query_params.append(('typicalTitlesSearch', typical_titles_search)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/compensation-benchmarks/jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_locations( + self, + parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level member, use the value `root`. ")] = None, + country_code: Annotated[Optional[StrictStr], Field(description="The **ISO 3166-1** country code to look up. Returns location members that match the country code. Currently, the only supported country code is `US`. ")] = None, + postal_code: Annotated[Optional[StrictStr], Field(description="Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[DimensionMember]: + """Get locations + + Retrieve a list of all available locations. + + :param parent: The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level member, use the value `root`. + :type parent: str + :param country_code: The **ISO 3166-1** country code to look up. Returns location members that match the country code. Currently, the only supported country code is `US`. + :type country_code: str + :param postal_code: Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. + :type postal_code: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_locations_serialize( + parent=parent, + country_code=country_code, + postal_code=postal_code, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_locations_with_http_info( + self, + parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level member, use the value `root`. ")] = None, + country_code: Annotated[Optional[StrictStr], Field(description="The **ISO 3166-1** country code to look up. Returns location members that match the country code. Currently, the only supported country code is `US`. ")] = None, + postal_code: Annotated[Optional[StrictStr], Field(description="Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[DimensionMember]]: + """Get locations + + Retrieve a list of all available locations. + + :param parent: The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level member, use the value `root`. + :type parent: str + :param country_code: The **ISO 3166-1** country code to look up. Returns location members that match the country code. Currently, the only supported country code is `US`. + :type country_code: str + :param postal_code: Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. + :type postal_code: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_locations_serialize( + parent=parent, + country_code=country_code, + postal_code=postal_code, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_locations_without_preload_content( + self, + parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level member, use the value `root`. ")] = None, + country_code: Annotated[Optional[StrictStr], Field(description="The **ISO 3166-1** country code to look up. Returns location members that match the country code. Currently, the only supported country code is `US`. ")] = None, + postal_code: Annotated[Optional[StrictStr], Field(description="Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. ")] = None, + has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get locations + + Retrieve a list of all available locations. + + :param parent: The ID of the parent member. If the ID is provided, the response returns the immediate children of the parent member. To get the top-level member, use the value `root`. + :type parent: str + :param country_code: The **ISO 3166-1** country code to look up. Returns location members that match the country code. Currently, the only supported country code is `US`. + :type country_code: str + :param postal_code: Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. + :type postal_code: str + :param has_benchmark_value: Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. + :type has_benchmark_value: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_locations_serialize( + parent=parent, + country_code=country_code, + postal_code=postal_code, + has_benchmark_value=has_benchmark_value, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[DimensionMember]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_locations_serialize( + self, + parent, + country_code, + postal_code, + has_benchmark_value, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if parent is not None: + + _query_params.append(('parent', parent)) + + if country_code is not None: + + _query_params.append(('countryCode', country_code)) + + if postal_code is not None: + + _query_params.append(('postalCode', postal_code)) + + if has_benchmark_value is not None: + + _query_params.append(('hasBenchmarkValue', has_benchmark_value)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/compensation-benchmarks/locations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def search_jobs( + self, + job_search_input: Annotated[JobSearchInput, Field(description="The job IDs that you want to retrieve a job match. Include the mandatory `jobIDs` field. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> JobSearchOutput: + """Search jobs by IDs + + Retrieve a matching job for each specified job ID. + + :param job_search_input: The job IDs that you want to retrieve a job match. Include the mandatory `jobIDs` field. (required) + :type job_search_input: JobSearchInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_jobs_serialize( + job_search_input=job_search_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JobSearchOutput", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def search_jobs_with_http_info( + self, + job_search_input: Annotated[JobSearchInput, Field(description="The job IDs that you want to retrieve a job match. Include the mandatory `jobIDs` field. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[JobSearchOutput]: + """Search jobs by IDs + + Retrieve a matching job for each specified job ID. + + :param job_search_input: The job IDs that you want to retrieve a job match. Include the mandatory `jobIDs` field. (required) + :type job_search_input: JobSearchInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_jobs_serialize( + job_search_input=job_search_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JobSearchOutput", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def search_jobs_without_preload_content( + self, + job_search_input: Annotated[JobSearchInput, Field(description="The job IDs that you want to retrieve a job match. Include the mandatory `jobIDs` field. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Search jobs by IDs + + Retrieve a matching job for each specified job ID. + + :param job_search_input: The job IDs that you want to retrieve a job match. Include the mandatory `jobIDs` field. (required) + :type job_search_input: JobSearchInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_jobs_serialize( + job_search_input=job_search_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "JobSearchOutput", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _search_jobs_serialize( + self, + job_search_input, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if job_search_input is not None: + _body_params = job_search_input + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/compensation-benchmarks/jobs/search', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def search_locations_in_bulk( + self, + location_search_input: Annotated[LocationSearchInput, Field(description="A list of requests that contain a combination of country and postal codes to look up. Returns location members that match both codes. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> LocationSearchOutput: + """Get location members in bulk + + Retrieve location members in bulk by country code and postal code. + + :param location_search_input: A list of requests that contain a combination of country and postal codes to look up. Returns location members that match both codes. (required) + :type location_search_input: LocationSearchInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_locations_in_bulk_serialize( + location_search_input=location_search_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "LocationSearchOutput", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def search_locations_in_bulk_with_http_info( + self, + location_search_input: Annotated[LocationSearchInput, Field(description="A list of requests that contain a combination of country and postal codes to look up. Returns location members that match both codes. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[LocationSearchOutput]: + """Get location members in bulk + + Retrieve location members in bulk by country code and postal code. + + :param location_search_input: A list of requests that contain a combination of country and postal codes to look up. Returns location members that match both codes. (required) + :type location_search_input: LocationSearchInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_locations_in_bulk_serialize( + location_search_input=location_search_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "LocationSearchOutput", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def search_locations_in_bulk_without_preload_content( + self, + location_search_input: Annotated[LocationSearchInput, Field(description="A list of requests that contain a combination of country and postal codes to look up. Returns location members that match both codes. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get location members in bulk + + Retrieve location members in bulk by country code and postal code. + + :param location_search_input: A list of requests that contain a combination of country and postal codes to look up. Returns location members that match both codes. (required) + :type location_search_input: LocationSearchInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_locations_in_bulk_serialize( + location_search_input=location_search_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "LocationSearchOutput", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _search_locations_in_bulk_serialize( + self, + location_search_input, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if location_search_input is not None: + _body_params = location_search_input + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/compensation-benchmarks/locations/search', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def standardize_jobs_in_bulk( + self, + job_standardization_input: Annotated[JobStandardizationInput, Field(description="The custom job titles that you want to retrieve standardized jobs for, the optional NAICS code to retrieve industry specific jobs, and the optional number of top matches to retrieve. By default, both semantic and lexical search are used to find matches. If you want to use a specific search method, set one of the parameters `semanticOnly` or `lexicalOnly` to `true`. Default for `semanticOnly` and `lexicalOnly` are `false`. The minimum custom job title length is 3 characters and the maximum length is 100 characters. You can submit up to 30 custom job titles per request. The default number of top matches returned is 5. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[OutputEntry]: + """Standardize custom job titles in bulk + + Find the top standardized job matches for any custom job title and optional NAICS code in bulk. + + :param job_standardization_input: The custom job titles that you want to retrieve standardized jobs for, the optional NAICS code to retrieve industry specific jobs, and the optional number of top matches to retrieve. By default, both semantic and lexical search are used to find matches. If you want to use a specific search method, set one of the parameters `semanticOnly` or `lexicalOnly` to `true`. Default for `semanticOnly` and `lexicalOnly` are `false`. The minimum custom job title length is 3 characters and the maximum length is 100 characters. You can submit up to 30 custom job titles per request. The default number of top matches returned is 5. (required) + :type job_standardization_input: JobStandardizationInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._standardize_jobs_in_bulk_serialize( + job_standardization_input=job_standardization_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[OutputEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def standardize_jobs_in_bulk_with_http_info( + self, + job_standardization_input: Annotated[JobStandardizationInput, Field(description="The custom job titles that you want to retrieve standardized jobs for, the optional NAICS code to retrieve industry specific jobs, and the optional number of top matches to retrieve. By default, both semantic and lexical search are used to find matches. If you want to use a specific search method, set one of the parameters `semanticOnly` or `lexicalOnly` to `true`. Default for `semanticOnly` and `lexicalOnly` are `false`. The minimum custom job title length is 3 characters and the maximum length is 100 characters. You can submit up to 30 custom job titles per request. The default number of top matches returned is 5. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[OutputEntry]]: + """Standardize custom job titles in bulk + + Find the top standardized job matches for any custom job title and optional NAICS code in bulk. + + :param job_standardization_input: The custom job titles that you want to retrieve standardized jobs for, the optional NAICS code to retrieve industry specific jobs, and the optional number of top matches to retrieve. By default, both semantic and lexical search are used to find matches. If you want to use a specific search method, set one of the parameters `semanticOnly` or `lexicalOnly` to `true`. Default for `semanticOnly` and `lexicalOnly` are `false`. The minimum custom job title length is 3 characters and the maximum length is 100 characters. You can submit up to 30 custom job titles per request. The default number of top matches returned is 5. (required) + :type job_standardization_input: JobStandardizationInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._standardize_jobs_in_bulk_serialize( + job_standardization_input=job_standardization_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[OutputEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def standardize_jobs_in_bulk_without_preload_content( + self, + job_standardization_input: Annotated[JobStandardizationInput, Field(description="The custom job titles that you want to retrieve standardized jobs for, the optional NAICS code to retrieve industry specific jobs, and the optional number of top matches to retrieve. By default, both semantic and lexical search are used to find matches. If you want to use a specific search method, set one of the parameters `semanticOnly` or `lexicalOnly` to `true`. Default for `semanticOnly` and `lexicalOnly` are `false`. The minimum custom job title length is 3 characters and the maximum length is 100 characters. You can submit up to 30 custom job titles per request. The default number of top matches returned is 5. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Standardize custom job titles in bulk + + Find the top standardized job matches for any custom job title and optional NAICS code in bulk. + + :param job_standardization_input: The custom job titles that you want to retrieve standardized jobs for, the optional NAICS code to retrieve industry specific jobs, and the optional number of top matches to retrieve. By default, both semantic and lexical search are used to find matches. If you want to use a specific search method, set one of the parameters `semanticOnly` or `lexicalOnly` to `true`. Default for `semanticOnly` and `lexicalOnly` are `false`. The minimum custom job title length is 3 characters and the maximum length is 100 characters. You can submit up to 30 custom job titles per request. The default number of top matches returned is 5. (required) + :type job_standardization_input: JobStandardizationInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._standardize_jobs_in_bulk_serialize( + job_standardization_input=job_standardization_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[OutputEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _standardize_jobs_in_bulk_serialize( + self, + job_standardization_input, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if job_standardization_input is not None: + _body_params = job_standardization_input + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/compensation-benchmarks/jobs/standardize', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def submit_jobs_feedback( + self, + job_feedback_input: Annotated[JobFeedbackInput, Field(description="The feedback you want to submit for. Ensure to include the mandatory fields: search term (`term`). ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Send feedback to help improve the quality of the job match results + + This API allows you to submit feedback on the quality of the job match results returned by the Get jobs endpoint. You must include the search term (job title you entered) in the request body. You can include the optional `naicsCode` if it was used as part of the search in the Get jobs endpoint. You can also submit additional comments by providing values for `additionalComments`, along with `term` and `naicsCode`. **Note:** For `term`, the minimum is 3 characters and the maximum is 100 characters. For `additionalComments`, the maximum is 150 characters. + + :param job_feedback_input: The feedback you want to submit for. Ensure to include the mandatory fields: search term (`term`). (required) + :type job_feedback_input: JobFeedbackInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._submit_jobs_feedback_serialize( + job_feedback_input=job_feedback_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def submit_jobs_feedback_with_http_info( + self, + job_feedback_input: Annotated[JobFeedbackInput, Field(description="The feedback you want to submit for. Ensure to include the mandatory fields: search term (`term`). ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Send feedback to help improve the quality of the job match results + + This API allows you to submit feedback on the quality of the job match results returned by the Get jobs endpoint. You must include the search term (job title you entered) in the request body. You can include the optional `naicsCode` if it was used as part of the search in the Get jobs endpoint. You can also submit additional comments by providing values for `additionalComments`, along with `term` and `naicsCode`. **Note:** For `term`, the minimum is 3 characters and the maximum is 100 characters. For `additionalComments`, the maximum is 150 characters. + + :param job_feedback_input: The feedback you want to submit for. Ensure to include the mandatory fields: search term (`term`). (required) + :type job_feedback_input: JobFeedbackInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._submit_jobs_feedback_serialize( + job_feedback_input=job_feedback_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def submit_jobs_feedback_without_preload_content( + self, + job_feedback_input: Annotated[JobFeedbackInput, Field(description="The feedback you want to submit for. Ensure to include the mandatory fields: search term (`term`). ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Send feedback to help improve the quality of the job match results + + This API allows you to submit feedback on the quality of the job match results returned by the Get jobs endpoint. You must include the search term (job title you entered) in the request body. You can include the optional `naicsCode` if it was used as part of the search in the Get jobs endpoint. You can also submit additional comments by providing values for `additionalComments`, along with `term` and `naicsCode`. **Note:** For `term`, the minimum is 3 characters and the maximum is 100 characters. For `additionalComments`, the maximum is 150 characters. + + :param job_feedback_input: The feedback you want to submit for. Ensure to include the mandatory fields: search term (`term`). (required) + :type job_feedback_input: JobFeedbackInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._submit_jobs_feedback_serialize( + job_feedback_input=job_feedback_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _submit_jobs_feedback_serialize( + self, + job_feedback_input, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if job_feedback_input is not None: + _body_params = job_feedback_input + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/compensation-benchmarks/jobs/feedback', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/direct_data_intake_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/direct_data_intake_api.py new file mode 100644 index 0000000000..eb36dd0d55 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/direct_data_intake_api.py @@ -0,0 +1,3039 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBytes, StrictStr +from typing import Optional, Tuple, Union +from typing_extensions import Annotated +from visier_platform_sdk.models.direct_data_upload_file_response_dto import DirectDataUploadFileResponseDTO +from visier_platform_sdk.models.servicing_direct_data_job_status_response_dto import ServicingDirectDataJobStatusResponseDTO +from visier_platform_sdk.models.servicing_direct_data_list_transactions_response_dto import ServicingDirectDataListTransactionsResponseDTO +from visier_platform_sdk.models.servicing_direct_data_load_config_dto import ServicingDirectDataLoadConfigDTO +from visier_platform_sdk.models.servicing_direct_data_schema_dto import ServicingDirectDataSchemaDTO +from visier_platform_sdk.models.servicing_direct_data_transaction_start_response_dto import ServicingDirectDataTransactionStartResponseDTO +from visier_platform_sdk.models.servicing_direct_data_upload_file_response_dto import ServicingDirectDataUploadFileResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class DirectDataIntakeApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def commit_transaction( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDirectDataUploadFileResponseDTO: + """Commit a transaction + + Process a transaction and its uploaded data files. This starts a processing job to load the data files into Visier. After committing a transaction, you cannot upload additional files to the transaction. Use the `Check transaction status` endpoint to monitor the progress of the processing job. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction. (required) + :type transaction_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._commit_transaction_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def commit_transaction_with_http_info( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDirectDataUploadFileResponseDTO]: + """Commit a transaction + + Process a transaction and its uploaded data files. This starts a processing job to load the data files into Visier. After committing a transaction, you cannot upload additional files to the transaction. Use the `Check transaction status` endpoint to monitor the progress of the processing job. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction. (required) + :type transaction_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._commit_transaction_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def commit_transaction_without_preload_content( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Commit a transaction + + Process a transaction and its uploaded data files. This starts a processing job to load the data files into Visier. After committing a transaction, you cannot upload additional files to the transaction. Use the `Check transaction status` endpoint to monitor the progress of the processing job. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction. (required) + :type transaction_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._commit_transaction_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _commit_transaction_serialize( + self, + draft_id, + transaction_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if draft_id is not None: + _path_params['draftId'] = draft_id + if transaction_id is not None: + _path_params['transactionId'] = transaction_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/data/directloads/{draftId}/transactions/{transactionId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_config( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDirectDataLoadConfigDTO: + """Get the direct data intake configuration + + Get the direct data intake configuration. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_config_serialize( + draft_id=draft_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataLoadConfigDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_config_with_http_info( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDirectDataLoadConfigDTO]: + """Get the direct data intake configuration + + Get the direct data intake configuration. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_config_serialize( + draft_id=draft_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataLoadConfigDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_config_without_preload_content( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get the direct data intake configuration + + Get the direct data intake configuration. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_config_serialize( + draft_id=draft_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataLoadConfigDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_config_serialize( + self, + draft_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if draft_id is not None: + _path_params['draftId'] = draft_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/directloads/{draftId}/configs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def job_status( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDirectDataJobStatusResponseDTO: + """Check transaction status + + Retrieve the status of a committed transaction's processing job. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction. (required) + :type transaction_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._job_status_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataJobStatusResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def job_status_with_http_info( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDirectDataJobStatusResponseDTO]: + """Check transaction status + + Retrieve the status of a committed transaction's processing job. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction. (required) + :type transaction_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._job_status_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataJobStatusResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def job_status_without_preload_content( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Check transaction status + + Retrieve the status of a committed transaction's processing job. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction. (required) + :type transaction_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._job_status_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataJobStatusResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _job_status_serialize( + self, + draft_id, + transaction_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if draft_id is not None: + _path_params['draftId'] = draft_id + if transaction_id is not None: + _path_params['transactionId'] = transaction_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/directloads/{draftId}/transactions/{transactionId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_transactions( + self, + draft_id: Annotated[StrictStr, Field(description="Optionally specify the unique identifier of a project to retrieve open transactions from. Currently, the only supported value is `prod` to retrieve open transactions for the production version.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDirectDataListTransactionsResponseDTO: + """Retrieve a list of open transactions + + Get a list of all open transactions. Doesn't return committed transactions or rolled back transactions. + + :param draft_id: Optionally specify the unique identifier of a project to retrieve open transactions from. Currently, the only supported value is `prod` to retrieve open transactions for the production version. (required) + :type draft_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_transactions_serialize( + draft_id=draft_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataListTransactionsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_transactions_with_http_info( + self, + draft_id: Annotated[StrictStr, Field(description="Optionally specify the unique identifier of a project to retrieve open transactions from. Currently, the only supported value is `prod` to retrieve open transactions for the production version.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDirectDataListTransactionsResponseDTO]: + """Retrieve a list of open transactions + + Get a list of all open transactions. Doesn't return committed transactions or rolled back transactions. + + :param draft_id: Optionally specify the unique identifier of a project to retrieve open transactions from. Currently, the only supported value is `prod` to retrieve open transactions for the production version. (required) + :type draft_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_transactions_serialize( + draft_id=draft_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataListTransactionsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_transactions_without_preload_content( + self, + draft_id: Annotated[StrictStr, Field(description="Optionally specify the unique identifier of a project to retrieve open transactions from. Currently, the only supported value is `prod` to retrieve open transactions for the production version.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of open transactions + + Get a list of all open transactions. Doesn't return committed transactions or rolled back transactions. + + :param draft_id: Optionally specify the unique identifier of a project to retrieve open transactions from. Currently, the only supported value is `prod` to retrieve open transactions for the production version. (required) + :type draft_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_transactions_serialize( + draft_id=draft_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataListTransactionsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_transactions_serialize( + self, + draft_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if draft_id is not None: + _path_params['draftId'] = draft_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/directloads/{draftId}/transactions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def load_sample_data( + self, + draft_id: StrictStr, + transaction_id: StrictStr, + object_name: StrictStr, + sample_name: Annotated[Optional[StrictStr], Field(description="The name of the target object to load sample data. Sample data is available for: * `employee`: The Employee subject. * `employee_exit`: The Employee Exit event. * `employment_start`: The Employment Start event. * `organization_hierarchy`: The Organization Hierarchy dimension.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDirectDataUploadFileResponseDTO: + """Load sample data + + Load sample data in a previously-created transaction. The data is not processed in Visier until you commit the transaction. Sample data is available for `employee`, `employee_exit`, `employment_start`, and `organization_hierarchy`. + + :param draft_id: (required) + :type draft_id: str + :param transaction_id: (required) + :type transaction_id: str + :param object_name: (required) + :type object_name: str + :param sample_name: The name of the target object to load sample data. Sample data is available for: * `employee`: The Employee subject. * `employee_exit`: The Employee Exit event. * `employment_start`: The Employment Start event. * `organization_hierarchy`: The Organization Hierarchy dimension. + :type sample_name: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._load_sample_data_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + object_name=object_name, + sample_name=sample_name, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def load_sample_data_with_http_info( + self, + draft_id: StrictStr, + transaction_id: StrictStr, + object_name: StrictStr, + sample_name: Annotated[Optional[StrictStr], Field(description="The name of the target object to load sample data. Sample data is available for: * `employee`: The Employee subject. * `employee_exit`: The Employee Exit event. * `employment_start`: The Employment Start event. * `organization_hierarchy`: The Organization Hierarchy dimension.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDirectDataUploadFileResponseDTO]: + """Load sample data + + Load sample data in a previously-created transaction. The data is not processed in Visier until you commit the transaction. Sample data is available for `employee`, `employee_exit`, `employment_start`, and `organization_hierarchy`. + + :param draft_id: (required) + :type draft_id: str + :param transaction_id: (required) + :type transaction_id: str + :param object_name: (required) + :type object_name: str + :param sample_name: The name of the target object to load sample data. Sample data is available for: * `employee`: The Employee subject. * `employee_exit`: The Employee Exit event. * `employment_start`: The Employment Start event. * `organization_hierarchy`: The Organization Hierarchy dimension. + :type sample_name: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._load_sample_data_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + object_name=object_name, + sample_name=sample_name, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def load_sample_data_without_preload_content( + self, + draft_id: StrictStr, + transaction_id: StrictStr, + object_name: StrictStr, + sample_name: Annotated[Optional[StrictStr], Field(description="The name of the target object to load sample data. Sample data is available for: * `employee`: The Employee subject. * `employee_exit`: The Employee Exit event. * `employment_start`: The Employment Start event. * `organization_hierarchy`: The Organization Hierarchy dimension.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Load sample data + + Load sample data in a previously-created transaction. The data is not processed in Visier until you commit the transaction. Sample data is available for `employee`, `employee_exit`, `employment_start`, and `organization_hierarchy`. + + :param draft_id: (required) + :type draft_id: str + :param transaction_id: (required) + :type transaction_id: str + :param object_name: (required) + :type object_name: str + :param sample_name: The name of the target object to load sample data. Sample data is available for: * `employee`: The Employee subject. * `employee_exit`: The Employee Exit event. * `employment_start`: The Employment Start event. * `organization_hierarchy`: The Organization Hierarchy dimension. + :type sample_name: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._load_sample_data_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + object_name=object_name, + sample_name=sample_name, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _load_sample_data_serialize( + self, + draft_id, + transaction_id, + object_name, + sample_name, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if draft_id is not None: + _path_params['draftId'] = draft_id + if transaction_id is not None: + _path_params['transactionId'] = transaction_id + if object_name is not None: + _path_params['objectName'] = object_name + # process the query parameters + if sample_name is not None: + + _query_params.append(('sampleName', sample_name)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/data/directloads/{draftId}/transactions/{transactionId}/{objectName}/sample-data', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def object_schema( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + object_name: Annotated[StrictStr, Field(description="The name of the object to return the load schema for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDirectDataSchemaDTO: + """Retrieve an object's data load schema + + Gets the load schema for a specified object. The object's load schema represents the structure that the data upload file must follow to upload data to the object. In the load schema, the listed columns must be present in the data file as column headers and exactly match the load schema (case sensitive), however, only the columns whose `isMandatory` field is `true` must contain values in the data file. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param object_name: The name of the object to return the load schema for. (required) + :type object_name: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._object_schema_serialize( + draft_id=draft_id, + object_name=object_name, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataSchemaDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def object_schema_with_http_info( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + object_name: Annotated[StrictStr, Field(description="The name of the object to return the load schema for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDirectDataSchemaDTO]: + """Retrieve an object's data load schema + + Gets the load schema for a specified object. The object's load schema represents the structure that the data upload file must follow to upload data to the object. In the load schema, the listed columns must be present in the data file as column headers and exactly match the load schema (case sensitive), however, only the columns whose `isMandatory` field is `true` must contain values in the data file. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param object_name: The name of the object to return the load schema for. (required) + :type object_name: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._object_schema_serialize( + draft_id=draft_id, + object_name=object_name, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataSchemaDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def object_schema_without_preload_content( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + object_name: Annotated[StrictStr, Field(description="The name of the object to return the load schema for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an object's data load schema + + Gets the load schema for a specified object. The object's load schema represents the structure that the data upload file must follow to upload data to the object. In the load schema, the listed columns must be present in the data file as column headers and exactly match the load schema (case sensitive), however, only the columns whose `isMandatory` field is `true` must contain values in the data file. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param object_name: The name of the object to return the load schema for. (required) + :type object_name: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._object_schema_serialize( + draft_id=draft_id, + object_name=object_name, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataSchemaDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _object_schema_serialize( + self, + draft_id, + object_name, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if draft_id is not None: + _path_params['draftId'] = draft_id + if object_name is not None: + _path_params['objectName'] = object_name + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/data/directloads/{draftId}/schemas/{objectName}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def put_config( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + servicing_direct_data_load_config_dto: ServicingDirectDataLoadConfigDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDirectDataLoadConfigDTO: + """Update the direct data intake configuration + + Configure the data intake settings, such as the direct data intake job type. Only provide values for the configuration options that should change. Configuration options that are not present in the PUT request are ignored and left unchanged. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param servicing_direct_data_load_config_dto: (required) + :type servicing_direct_data_load_config_dto: ServicingDirectDataLoadConfigDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_config_serialize( + draft_id=draft_id, + servicing_direct_data_load_config_dto=servicing_direct_data_load_config_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataLoadConfigDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_config_with_http_info( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + servicing_direct_data_load_config_dto: ServicingDirectDataLoadConfigDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDirectDataLoadConfigDTO]: + """Update the direct data intake configuration + + Configure the data intake settings, such as the direct data intake job type. Only provide values for the configuration options that should change. Configuration options that are not present in the PUT request are ignored and left unchanged. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param servicing_direct_data_load_config_dto: (required) + :type servicing_direct_data_load_config_dto: ServicingDirectDataLoadConfigDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_config_serialize( + draft_id=draft_id, + servicing_direct_data_load_config_dto=servicing_direct_data_load_config_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataLoadConfigDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_config_without_preload_content( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + servicing_direct_data_load_config_dto: ServicingDirectDataLoadConfigDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update the direct data intake configuration + + Configure the data intake settings, such as the direct data intake job type. Only provide values for the configuration options that should change. Configuration options that are not present in the PUT request are ignored and left unchanged. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param servicing_direct_data_load_config_dto: (required) + :type servicing_direct_data_load_config_dto: ServicingDirectDataLoadConfigDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_config_serialize( + draft_id=draft_id, + servicing_direct_data_load_config_dto=servicing_direct_data_load_config_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataLoadConfigDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_config_serialize( + self, + draft_id, + servicing_direct_data_load_config_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if draft_id is not None: + _path_params['draftId'] = draft_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_direct_data_load_config_dto is not None: + _body_params = servicing_direct_data_load_config_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/data/directloads/{draftId}/configs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def rollback_transaction( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDirectDataUploadFileResponseDTO: + """Roll back a transaction + + Rolls back the specified transaction. This discards all files uploaded within the transaction and deletes the transaction. After rolling back a transaction, you cannot use the transaction to upload data files. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction. (required) + :type transaction_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._rollback_transaction_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def rollback_transaction_with_http_info( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDirectDataUploadFileResponseDTO]: + """Roll back a transaction + + Rolls back the specified transaction. This discards all files uploaded within the transaction and deletes the transaction. After rolling back a transaction, you cannot use the transaction to upload data files. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction. (required) + :type transaction_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._rollback_transaction_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def rollback_transaction_without_preload_content( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Roll back a transaction + + Rolls back the specified transaction. This discards all files uploaded within the transaction and deletes the transaction. After rolling back a transaction, you cannot use the transaction to upload data files. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction. (required) + :type transaction_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._rollback_transaction_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _rollback_transaction_serialize( + self, + draft_id, + transaction_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if draft_id is not None: + _path_params['draftId'] = draft_id + if transaction_id is not None: + _path_params['transactionId'] = transaction_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/data/directloads/{draftId}/transactions/{transactionId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def start_transaction( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDirectDataTransactionStartResponseDTO: + """Start a direct data intake transaction + + Create a transaction to contain your data files. To upload files to objects in Visier, you must first start a transaction. After starting a transaction and uploading files to the transaction, you can commit the transaction to process the uploaded files or roll back the transaction to discard the uploaded files. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_transaction_serialize( + draft_id=draft_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataTransactionStartResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def start_transaction_with_http_info( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDirectDataTransactionStartResponseDTO]: + """Start a direct data intake transaction + + Create a transaction to contain your data files. To upload files to objects in Visier, you must first start a transaction. After starting a transaction and uploading files to the transaction, you can commit the transaction to process the uploaded files or roll back the transaction to discard the uploaded files. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_transaction_serialize( + draft_id=draft_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataTransactionStartResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def start_transaction_without_preload_content( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Start a direct data intake transaction + + Create a transaction to contain your data files. To upload files to objects in Visier, you must first start a transaction. After starting a transaction and uploading files to the transaction, you can commit the transaction to process the uploaded files or roll back the transaction to discard the uploaded files. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._start_transaction_serialize( + draft_id=draft_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDirectDataTransactionStartResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _start_transaction_serialize( + self, + draft_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if draft_id is not None: + _path_params['draftId'] = draft_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/data/directloads/{draftId}/transactions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def upload_file( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction to load data files into.")], + object_name: Annotated[StrictStr, Field(description="The name of the object to upload the data to. If uploading data to a multi-value property (MVP), specify the property in `{object}--{property}` format; for example, `Employee--Employee_Budgeted_Compensation`.")], + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to upload")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DirectDataUploadFileResponseDTO: + """Upload files + + Send upload files to a previously-created transaction. Each upload file is associated with a target object in Visier. The files are not processed in Visier until you commit the transaction. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction to load data files into. (required) + :type transaction_id: str + :param object_name: The name of the object to upload the data to. If uploading data to a multi-value property (MVP), specify the property in `{object}--{property}` format; for example, `Employee--Employee_Budgeted_Compensation`. (required) + :type object_name: str + :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. + :type target_tenant_id: str + :param file: The file to upload + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upload_file_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + object_name=object_name, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def upload_file_with_http_info( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction to load data files into.")], + object_name: Annotated[StrictStr, Field(description="The name of the object to upload the data to. If uploading data to a multi-value property (MVP), specify the property in `{object}--{property}` format; for example, `Employee--Employee_Budgeted_Compensation`.")], + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to upload")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DirectDataUploadFileResponseDTO]: + """Upload files + + Send upload files to a previously-created transaction. Each upload file is associated with a target object in Visier. The files are not processed in Visier until you commit the transaction. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction to load data files into. (required) + :type transaction_id: str + :param object_name: The name of the object to upload the data to. If uploading data to a multi-value property (MVP), specify the property in `{object}--{property}` format; for example, `Employee--Employee_Budgeted_Compensation`. (required) + :type object_name: str + :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. + :type target_tenant_id: str + :param file: The file to upload + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upload_file_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + object_name=object_name, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def upload_file_without_preload_content( + self, + draft_id: Annotated[StrictStr, Field(description="The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version.")], + transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction to load data files into.")], + object_name: Annotated[StrictStr, Field(description="The name of the object to upload the data to. If uploading data to a multi-value property (MVP), specify the property in `{object}--{property}` format; for example, `Employee--Employee_Budgeted_Compensation`.")], + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to upload")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Upload files + + Send upload files to a previously-created transaction. Each upload file is associated with a target object in Visier. The files are not processed in Visier until you commit the transaction. + + :param draft_id: The unique identifier of the project to load data into. Currently, the only supported value is `prod` to update the production version. (required) + :type draft_id: str + :param transaction_id: The unique identifier of the transaction to load data files into. (required) + :type transaction_id: str + :param object_name: The name of the object to upload the data to. If uploading data to a multi-value property (MVP), specify the property in `{object}--{property}` format; for example, `Employee--Employee_Budgeted_Compensation`. (required) + :type object_name: str + :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. + :type target_tenant_id: str + :param file: The file to upload + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upload_file_serialize( + draft_id=draft_id, + transaction_id=transaction_id, + object_name=object_name, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DirectDataUploadFileResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _upload_file_serialize( + self, + draft_id, + transaction_id, + object_name, + target_tenant_id, + file, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if draft_id is not None: + _path_params['draftId'] = draft_id + if transaction_id is not None: + _path_params['transactionId'] = transaction_id + if object_name is not None: + _path_params['objectName'] = object_name + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + if file is not None: + _files['file'] = file + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/data/directloads/{draftId}/transactions/{transactionId}/{objectName}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/email_domains_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/email_domains_api.py new file mode 100644 index 0000000000..b4d69f0ccf --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/email_domains_api.py @@ -0,0 +1,880 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_email_domains_dto import AdminEmailDomainsDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class EmailDomainsApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def add_allowed_email_domains( + self, + body: StrictStr, + confirm_not_allowed_domain: Annotated[Optional[StrictBool], Field(description="If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminEmailDomainsDTO: + """Add domains to the list of allowed domains + + Add email address domains to the allowed domains list.
**Note:** 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). + + :param body: (required) + :type body: str + :param confirm_not_allowed_domain: If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list. + :type confirm_not_allowed_domain: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_allowed_email_domains_serialize( + body=body, + confirm_not_allowed_domain=confirm_not_allowed_domain, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminEmailDomainsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def add_allowed_email_domains_with_http_info( + self, + body: StrictStr, + confirm_not_allowed_domain: Annotated[Optional[StrictBool], Field(description="If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminEmailDomainsDTO]: + """Add domains to the list of allowed domains + + Add email address domains to the allowed domains list.
**Note:** 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). + + :param body: (required) + :type body: str + :param confirm_not_allowed_domain: If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list. + :type confirm_not_allowed_domain: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_allowed_email_domains_serialize( + body=body, + confirm_not_allowed_domain=confirm_not_allowed_domain, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminEmailDomainsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def add_allowed_email_domains_without_preload_content( + self, + body: StrictStr, + confirm_not_allowed_domain: Annotated[Optional[StrictBool], Field(description="If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add domains to the list of allowed domains + + Add email address domains to the allowed domains list.
**Note:** 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). + + :param body: (required) + :type body: str + :param confirm_not_allowed_domain: If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list. + :type confirm_not_allowed_domain: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_allowed_email_domains_serialize( + body=body, + confirm_not_allowed_domain=confirm_not_allowed_domain, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminEmailDomainsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _add_allowed_email_domains_serialize( + self, + body, + confirm_not_allowed_domain, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if confirm_not_allowed_domain is not None: + + _query_params.append(('confirmNotAllowedDomain', confirm_not_allowed_domain)) + + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1alpha/admin/email-domains', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_allowed_email_domains( + self, + body: StrictStr, + confirm_not_allowed_domain: Annotated[Optional[StrictBool], Field(description="If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminEmailDomainsDTO: + """Remove domains from the list of allowed domains + + Delete email address domains from the allowed domains list.
**Note:** 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). + + :param body: (required) + :type body: str + :param confirm_not_allowed_domain: If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list. + :type confirm_not_allowed_domain: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_allowed_email_domains_serialize( + body=body, + confirm_not_allowed_domain=confirm_not_allowed_domain, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminEmailDomainsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_allowed_email_domains_with_http_info( + self, + body: StrictStr, + confirm_not_allowed_domain: Annotated[Optional[StrictBool], Field(description="If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminEmailDomainsDTO]: + """Remove domains from the list of allowed domains + + Delete email address domains from the allowed domains list.
**Note:** 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). + + :param body: (required) + :type body: str + :param confirm_not_allowed_domain: If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list. + :type confirm_not_allowed_domain: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_allowed_email_domains_serialize( + body=body, + confirm_not_allowed_domain=confirm_not_allowed_domain, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminEmailDomainsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_allowed_email_domains_without_preload_content( + self, + body: StrictStr, + confirm_not_allowed_domain: Annotated[Optional[StrictBool], Field(description="If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Remove domains from the list of allowed domains + + Delete email address domains from the allowed domains list.
**Note:** 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). + + :param body: (required) + :type body: str + :param confirm_not_allowed_domain: If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list. + :type confirm_not_allowed_domain: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_allowed_email_domains_serialize( + body=body, + confirm_not_allowed_domain=confirm_not_allowed_domain, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminEmailDomainsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_allowed_email_domains_serialize( + self, + body, + confirm_not_allowed_domain, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if confirm_not_allowed_domain is not None: + + _query_params.append(('confirmNotAllowedDomain', confirm_not_allowed_domain)) + + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1alpha/admin/email-domains', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_allowed_email_domains( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminEmailDomainsDTO: + """Retrieve a list of allowed email domains + + Retrieve the full list of allowed email domains.
**Note:** 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). + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_allowed_email_domains_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminEmailDomainsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_allowed_email_domains_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminEmailDomainsDTO]: + """Retrieve a list of allowed email domains + + Retrieve the full list of allowed email domains.
**Note:** 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). + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_allowed_email_domains_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminEmailDomainsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_allowed_email_domains_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of allowed email domains + + Retrieve the full list of allowed email domains.
**Note:** 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). + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_allowed_email_domains_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminEmailDomainsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_allowed_email_domains_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/admin/email-domains', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/encryption_keys_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/encryption_keys_api.py new file mode 100644 index 0000000000..8f976873a2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/encryption_keys_api.py @@ -0,0 +1,835 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_key_name import AdminKeyName +from visier_platform_sdk.models.designer_crypto_generate_key_request_dto import DesignerCryptoGenerateKeyRequestDTO +from visier_platform_sdk.models.designer_crypto_tenant_encryption_key_dto import DesignerCryptoTenantEncryptionKeyDTO +from visier_platform_sdk.models.designer_crypto_tenant_encryption_key_details_dto import DesignerCryptoTenantEncryptionKeyDetailsDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class EncryptionKeysApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def delete_encryption_keys( + self, + key_name: Annotated[StrictStr, Field(description="The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 3 and 36 characters long.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminKeyName: + """Delete an encryption key + + Delete a specific encryption key.
**Note:** 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). + + :param key_name: The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 3 and 36 characters long. (required) + :type key_name: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_encryption_keys_serialize( + key_name=key_name, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminKeyName", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_encryption_keys_with_http_info( + self, + key_name: Annotated[StrictStr, Field(description="The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 3 and 36 characters long.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminKeyName]: + """Delete an encryption key + + Delete a specific encryption key.
**Note:** 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). + + :param key_name: The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 3 and 36 characters long. (required) + :type key_name: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_encryption_keys_serialize( + key_name=key_name, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminKeyName", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_encryption_keys_without_preload_content( + self, + key_name: Annotated[StrictStr, Field(description="The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 3 and 36 characters long.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an encryption key + + Delete a specific encryption key.
**Note:** 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). + + :param key_name: The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 3 and 36 characters long. (required) + :type key_name: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_encryption_keys_serialize( + key_name=key_name, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminKeyName", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_encryption_keys_serialize( + self, + key_name, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if key_name is not None: + _path_params['keyName'] = key_name + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1alpha/admin/encryption-keys/{keyName}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def generate_encryption_keys( + self, + designer_crypto_generate_key_request_dto: DesignerCryptoGenerateKeyRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerCryptoTenantEncryptionKeyDTO: + """Generate an encryption key + + Create an encryption key using a specific algorithm. The algorithm must be one of `HmacSHA224`, `HmacSHA256`, `HmacSHA384`, or `HmacSHA512`. In the request body, set the algorithm, give the key a display name and, optionally, set the UTC expiration date for the key pair in ISO-8601 format. Must be between 2 and 10 years. Default is 2 years. The maximum number of encryption keys per tenant is 5.
**Note:** 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). + + :param designer_crypto_generate_key_request_dto: (required) + :type designer_crypto_generate_key_request_dto: DesignerCryptoGenerateKeyRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_encryption_keys_serialize( + designer_crypto_generate_key_request_dto=designer_crypto_generate_key_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoTenantEncryptionKeyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def generate_encryption_keys_with_http_info( + self, + designer_crypto_generate_key_request_dto: DesignerCryptoGenerateKeyRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerCryptoTenantEncryptionKeyDTO]: + """Generate an encryption key + + Create an encryption key using a specific algorithm. The algorithm must be one of `HmacSHA224`, `HmacSHA256`, `HmacSHA384`, or `HmacSHA512`. In the request body, set the algorithm, give the key a display name and, optionally, set the UTC expiration date for the key pair in ISO-8601 format. Must be between 2 and 10 years. Default is 2 years. The maximum number of encryption keys per tenant is 5.
**Note:** 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). + + :param designer_crypto_generate_key_request_dto: (required) + :type designer_crypto_generate_key_request_dto: DesignerCryptoGenerateKeyRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_encryption_keys_serialize( + designer_crypto_generate_key_request_dto=designer_crypto_generate_key_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoTenantEncryptionKeyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def generate_encryption_keys_without_preload_content( + self, + designer_crypto_generate_key_request_dto: DesignerCryptoGenerateKeyRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Generate an encryption key + + Create an encryption key using a specific algorithm. The algorithm must be one of `HmacSHA224`, `HmacSHA256`, `HmacSHA384`, or `HmacSHA512`. In the request body, set the algorithm, give the key a display name and, optionally, set the UTC expiration date for the key pair in ISO-8601 format. Must be between 2 and 10 years. Default is 2 years. The maximum number of encryption keys per tenant is 5.
**Note:** 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). + + :param designer_crypto_generate_key_request_dto: (required) + :type designer_crypto_generate_key_request_dto: DesignerCryptoGenerateKeyRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_encryption_keys_serialize( + designer_crypto_generate_key_request_dto=designer_crypto_generate_key_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoTenantEncryptionKeyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _generate_encryption_keys_serialize( + self, + designer_crypto_generate_key_request_dto, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if designer_crypto_generate_key_request_dto is not None: + _body_params = designer_crypto_generate_key_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/admin/encryption-keys', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_all_encryption_keys_metadata( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerCryptoTenantEncryptionKeyDetailsDTO: + """Retrieve a list of all encryption keys + + Retrieve a list of all encryption keys. The response returns information about each key, including the key name, algorithm, user who generated the key, the generation date, and expiration date.
**Note:** 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). + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_all_encryption_keys_metadata_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoTenantEncryptionKeyDetailsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_all_encryption_keys_metadata_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerCryptoTenantEncryptionKeyDetailsDTO]: + """Retrieve a list of all encryption keys + + Retrieve a list of all encryption keys. The response returns information about each key, including the key name, algorithm, user who generated the key, the generation date, and expiration date.
**Note:** 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). + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_all_encryption_keys_metadata_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoTenantEncryptionKeyDetailsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_all_encryption_keys_metadata_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all encryption keys + + Retrieve a list of all encryption keys. The response returns information about each key, including the key name, algorithm, user who generated the key, the generation date, and expiration date.
**Note:** 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). + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_all_encryption_keys_metadata_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoTenantEncryptionKeyDetailsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_all_encryption_keys_metadata_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/admin/encryption-keys', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/jobs_library_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/jobs_library_api.py new file mode 100644 index 0000000000..7e33425819 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/jobs_library_api.py @@ -0,0 +1,1168 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import List, Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.job import Job +from visier_platform_sdk.models.job_entry import JobEntry +from visier_platform_sdk.models.job_standardization_input_skills import JobStandardizationInputSkills +from visier_platform_sdk.models.output_entry1 import OutputEntry1 + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class JobsLibraryApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def get_job( + self, + id: Annotated[StrictStr, Field(description="The ID of the job to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> Job: + """Get job details by ID + + If you know the ID of a job, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, alternative names, and skills. + + :param id: The ID of the job to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_job_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Job", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_job_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ID of the job to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[Job]: + """Get job details by ID + + If you know the ID of a job, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, alternative names, and skills. + + :param id: The ID of the job to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_job_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Job", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_job_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ID of the job to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get job details by ID + + If you know the ID of a job, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, alternative names, and skills. + + :param id: The ID of the job to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_job_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Job", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_job_serialize( + self, + id, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/jobs/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_jobs( + self, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[JobEntry]: + """Retrieve a list of jobs + + Use this endpoint to retrieve all the jobs in Visier's Jobs Library. + + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_jobs_serialize( + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[JobEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_jobs_with_http_info( + self, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[JobEntry]]: + """Retrieve a list of jobs + + Use this endpoint to retrieve all the jobs in Visier's Jobs Library. + + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_jobs_serialize( + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[JobEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_jobs_without_preload_content( + self, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of jobs + + Use this endpoint to retrieve all the jobs in Visier's Jobs Library. + + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_jobs_serialize( + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[JobEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_jobs_serialize( + self, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/jobs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def search_job( + self, + term: Annotated[StrictStr, Field(description="The term to search for. The search term must be URL encoded and the minimum length is 3 characters. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[JobEntry]: + """Search jobs + + Retrieve a list of jobs that match a specified search term. + + :param term: The term to search for. The search term must be URL encoded and the minimum length is 3 characters. (required) + :type term: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_job_serialize( + term=term, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[JobEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def search_job_with_http_info( + self, + term: Annotated[StrictStr, Field(description="The term to search for. The search term must be URL encoded and the minimum length is 3 characters. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[JobEntry]]: + """Search jobs + + Retrieve a list of jobs that match a specified search term. + + :param term: The term to search for. The search term must be URL encoded and the minimum length is 3 characters. (required) + :type term: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_job_serialize( + term=term, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[JobEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def search_job_without_preload_content( + self, + term: Annotated[StrictStr, Field(description="The term to search for. The search term must be URL encoded and the minimum length is 3 characters. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Search jobs + + Retrieve a list of jobs that match a specified search term. + + :param term: The term to search for. The search term must be URL encoded and the minimum length is 3 characters. (required) + :type term: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_job_serialize( + term=term, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[JobEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _search_job_serialize( + self, + term, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if term is not None: + + _query_params.append(('term', term)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/jobs/search', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def standardize_jobs( + self, + job_standardization_input_skills: Annotated[JobStandardizationInputSkills, Field(description="The custom job titles that you want to retrieve standardized jobs for and the optional NAICS code to retrieve industry specific jobs. The minimum length is 3 characters and the maximum length is 100 characters. You can submit up to 10 custom job titles per request. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[OutputEntry1]: + """Standardize custom job titles + + Find the top standardized job matches for any custom job title and optional NAICS code. + + :param job_standardization_input_skills: The custom job titles that you want to retrieve standardized jobs for and the optional NAICS code to retrieve industry specific jobs. The minimum length is 3 characters and the maximum length is 100 characters. You can submit up to 10 custom job titles per request. (required) + :type job_standardization_input_skills: JobStandardizationInputSkills + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._standardize_jobs_serialize( + job_standardization_input_skills=job_standardization_input_skills, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[OutputEntry1]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def standardize_jobs_with_http_info( + self, + job_standardization_input_skills: Annotated[JobStandardizationInputSkills, Field(description="The custom job titles that you want to retrieve standardized jobs for and the optional NAICS code to retrieve industry specific jobs. The minimum length is 3 characters and the maximum length is 100 characters. You can submit up to 10 custom job titles per request. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[OutputEntry1]]: + """Standardize custom job titles + + Find the top standardized job matches for any custom job title and optional NAICS code. + + :param job_standardization_input_skills: The custom job titles that you want to retrieve standardized jobs for and the optional NAICS code to retrieve industry specific jobs. The minimum length is 3 characters and the maximum length is 100 characters. You can submit up to 10 custom job titles per request. (required) + :type job_standardization_input_skills: JobStandardizationInputSkills + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._standardize_jobs_serialize( + job_standardization_input_skills=job_standardization_input_skills, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[OutputEntry1]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def standardize_jobs_without_preload_content( + self, + job_standardization_input_skills: Annotated[JobStandardizationInputSkills, Field(description="The custom job titles that you want to retrieve standardized jobs for and the optional NAICS code to retrieve industry specific jobs. The minimum length is 3 characters and the maximum length is 100 characters. You can submit up to 10 custom job titles per request. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Standardize custom job titles + + Find the top standardized job matches for any custom job title and optional NAICS code. + + :param job_standardization_input_skills: The custom job titles that you want to retrieve standardized jobs for and the optional NAICS code to retrieve industry specific jobs. The minimum length is 3 characters and the maximum length is 100 characters. You can submit up to 10 custom job titles per request. (required) + :type job_standardization_input_skills: JobStandardizationInputSkills + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._standardize_jobs_serialize( + job_standardization_input_skills=job_standardization_input_skills, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[OutputEntry1]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _standardize_jobs_serialize( + self, + job_standardization_input_skills, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if job_standardization_input_skills is not None: + _body_params = job_standardization_input_skills + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/jobs/standardize', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/network_subnets_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/network_subnets_api.py new file mode 100644 index 0000000000..bf0106ecd8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/network_subnets_api.py @@ -0,0 +1,1170 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_network_subnets_message_request import AdminNetworkSubnetsMessageRequest +from visier_platform_sdk.models.admin_network_subnets_message_response import AdminNetworkSubnetsMessageResponse + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class NetworkSubnetsApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def add_api_subnets( + self, + admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminNetworkSubnetsMessageResponse: + """Add API network subnets + + Add IP addresses to the list of allowed network subnets that can call Visier APIs. IP addresses must use the Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx.
**Note:** 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). + + :param admin_network_subnets_message_request: (required) + :type admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_api_subnets_serialize( + admin_network_subnets_message_request=admin_network_subnets_message_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def add_api_subnets_with_http_info( + self, + admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminNetworkSubnetsMessageResponse]: + """Add API network subnets + + Add IP addresses to the list of allowed network subnets that can call Visier APIs. IP addresses must use the Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx.
**Note:** 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). + + :param admin_network_subnets_message_request: (required) + :type admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_api_subnets_serialize( + admin_network_subnets_message_request=admin_network_subnets_message_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def add_api_subnets_without_preload_content( + self, + admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add API network subnets + + Add IP addresses to the list of allowed network subnets that can call Visier APIs. IP addresses must use the Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx.
**Note:** 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). + + :param admin_network_subnets_message_request: (required) + :type admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_api_subnets_serialize( + admin_network_subnets_message_request=admin_network_subnets_message_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _add_api_subnets_serialize( + self, + admin_network_subnets_message_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if admin_network_subnets_message_request is not None: + _body_params = admin_network_subnets_message_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/admin/api-network-subnets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_api_subnets( + self, + admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminNetworkSubnetsMessageResponse: + """Delete API network subnets + + Remove IP addresses from the list of allowed network subnets that can call Visier APIs. IP addresses must use the Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx. When updating allowed network subnets, the definition in your API call replaces the prior definition. You must provide the entire definition in the PUT call. If you omit IP addresses from the update request, those IP addresses are removed from the allowlist We recommend that you retrieve the current list of allowed network subnets before you update the list. **Note**: By deleting the allowed network subnets, you may remove your current IP address from the allowlist. If this happens, you will lock yourself out from making additional API calls. Visier does not allow lock outs unless you set `confirmLockout` to `true`. Default is `false`.
**Note:** 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). + + :param admin_network_subnets_message_request: (required) + :type admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_api_subnets_serialize( + admin_network_subnets_message_request=admin_network_subnets_message_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_api_subnets_with_http_info( + self, + admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminNetworkSubnetsMessageResponse]: + """Delete API network subnets + + Remove IP addresses from the list of allowed network subnets that can call Visier APIs. IP addresses must use the Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx. When updating allowed network subnets, the definition in your API call replaces the prior definition. You must provide the entire definition in the PUT call. If you omit IP addresses from the update request, those IP addresses are removed from the allowlist We recommend that you retrieve the current list of allowed network subnets before you update the list. **Note**: By deleting the allowed network subnets, you may remove your current IP address from the allowlist. If this happens, you will lock yourself out from making additional API calls. Visier does not allow lock outs unless you set `confirmLockout` to `true`. Default is `false`.
**Note:** 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). + + :param admin_network_subnets_message_request: (required) + :type admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_api_subnets_serialize( + admin_network_subnets_message_request=admin_network_subnets_message_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_api_subnets_without_preload_content( + self, + admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete API network subnets + + Remove IP addresses from the list of allowed network subnets that can call Visier APIs. IP addresses must use the Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx. When updating allowed network subnets, the definition in your API call replaces the prior definition. You must provide the entire definition in the PUT call. If you omit IP addresses from the update request, those IP addresses are removed from the allowlist We recommend that you retrieve the current list of allowed network subnets before you update the list. **Note**: By deleting the allowed network subnets, you may remove your current IP address from the allowlist. If this happens, you will lock yourself out from making additional API calls. Visier does not allow lock outs unless you set `confirmLockout` to `true`. Default is `false`.
**Note:** 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). + + :param admin_network_subnets_message_request: (required) + :type admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_api_subnets_serialize( + admin_network_subnets_message_request=admin_network_subnets_message_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_api_subnets_serialize( + self, + admin_network_subnets_message_request, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_network_subnets_message_request is not None: + _body_params = admin_network_subnets_message_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1alpha/admin/api-network-subnets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_api_subnets( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminNetworkSubnetsMessageResponse: + """Retrieve a list of API network subnets + + Retrieve a list of all IP addresses that can call Visier APIs.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_api_subnets_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_api_subnets_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminNetworkSubnetsMessageResponse]: + """Retrieve a list of API network subnets + + Retrieve a list of all IP addresses that can call Visier APIs.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_api_subnets_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_api_subnets_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of API network subnets + + Retrieve a list of all IP addresses that can call Visier APIs.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_api_subnets_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_api_subnets_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/admin/api-network-subnets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def set_api_subnets( + self, + admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminNetworkSubnetsMessageResponse: + """Update API network subnets + + Overwrite the existing list of IP addresses that can call Visier APIs with a new list. IP addresses must use the Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx. When updating allowed network subnets, the definition in your API call replaces the prior definition. You must provide the entire definition in the PUT call. If you omit IP addresses from the update request, those IP addresses are removed from the allowlist We recommend that you retrieve the current list of allowed network subnets before you update the list. **Note**: By updating the allowed network subnets, you may remove your current IP address from the allowlist. If this happens, you will lock yourself out from making additional API calls. Visier does not allow lock outs unless you set `confirmLockout` to `true`. Default is `false`.
**Note:** 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). + + :param admin_network_subnets_message_request: (required) + :type admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_api_subnets_serialize( + admin_network_subnets_message_request=admin_network_subnets_message_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_api_subnets_with_http_info( + self, + admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminNetworkSubnetsMessageResponse]: + """Update API network subnets + + Overwrite the existing list of IP addresses that can call Visier APIs with a new list. IP addresses must use the Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx. When updating allowed network subnets, the definition in your API call replaces the prior definition. You must provide the entire definition in the PUT call. If you omit IP addresses from the update request, those IP addresses are removed from the allowlist We recommend that you retrieve the current list of allowed network subnets before you update the list. **Note**: By updating the allowed network subnets, you may remove your current IP address from the allowlist. If this happens, you will lock yourself out from making additional API calls. Visier does not allow lock outs unless you set `confirmLockout` to `true`. Default is `false`.
**Note:** 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). + + :param admin_network_subnets_message_request: (required) + :type admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_api_subnets_serialize( + admin_network_subnets_message_request=admin_network_subnets_message_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_api_subnets_without_preload_content( + self, + admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update API network subnets + + Overwrite the existing list of IP addresses that can call Visier APIs with a new list. IP addresses must use the Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx. When updating allowed network subnets, the definition in your API call replaces the prior definition. You must provide the entire definition in the PUT call. If you omit IP addresses from the update request, those IP addresses are removed from the allowlist We recommend that you retrieve the current list of allowed network subnets before you update the list. **Note**: By updating the allowed network subnets, you may remove your current IP address from the allowlist. If this happens, you will lock yourself out from making additional API calls. Visier does not allow lock outs unless you set `confirmLockout` to `true`. Default is `false`.
**Note:** 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). + + :param admin_network_subnets_message_request: (required) + :type admin_network_subnets_message_request: AdminNetworkSubnetsMessageRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_api_subnets_serialize( + admin_network_subnets_message_request=admin_network_subnets_message_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminNetworkSubnetsMessageResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_api_subnets_serialize( + self, + admin_network_subnets_message_request, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_network_subnets_message_request is not None: + _body_params = admin_network_subnets_message_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1alpha/admin/api-network-subnets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/o_auth2_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/o_auth2_api.py new file mode 100644 index 0000000000..7d52ceb770 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/o_auth2_api.py @@ -0,0 +1,1021 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.authentication_o_auth2_user_info_dto import AuthenticationOAuth2UserInfoDTO +from visier_platform_sdk.models.status import Status +from visier_platform_sdk.models.token_response import TokenResponse + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class OAuth2Api: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def o_auth2_token( + self, + grant_type: Annotated[Optional[StrictStr], Field(description="The grant type. Supported values: - `authorization_code`: The authorization code grant type. - `password`: The password grant type. - `urn:ietf:params:oauth:grant-type:saml2-bearer`: The saml2-bearer grant type. - `urn:visier:params:oauth:grant-type:asid-token`: The ASID token grant type.")] = None, + client_id: Annotated[Optional[StrictStr], Field(description="The ID of the pre-registered client application.")] = None, + client_secret: Annotated[Optional[StrictStr], Field(description="The secret of the pre-registered client application.")] = None, + redirect_uri: Annotated[Optional[StrictStr], Field(description="The optional URI to redirect to after authorization.")] = None, + code: Annotated[Optional[StrictStr], Field(description="The authorization code. Applicable only for authorization code grant type.")] = None, + username: Annotated[Optional[StrictStr], Field(description="The username of the user to authenticate. Applicable only for password grant type.")] = None, + password: Annotated[Optional[StrictStr], Field(description="The password of the user to authenticate. Applicable only for password grant type.")] = None, + asid_token: Annotated[Optional[StrictStr], Field(description="The ASID token. Applicable only for ASID token grant type.")] = None, + assertion: Annotated[Optional[StrictStr], Field(description="The SAML assertion. Applicable only for saml2-bearer grant type.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TokenResponse: + """Request a JSON Web Token + + Use an OAuth 2.0 grant type to request a JWT. + + :param grant_type: The grant type. Supported values: - `authorization_code`: The authorization code grant type. - `password`: The password grant type. - `urn:ietf:params:oauth:grant-type:saml2-bearer`: The saml2-bearer grant type. - `urn:visier:params:oauth:grant-type:asid-token`: The ASID token grant type. + :type grant_type: str + :param client_id: The ID of the pre-registered client application. + :type client_id: str + :param client_secret: The secret of the pre-registered client application. + :type client_secret: str + :param redirect_uri: The optional URI to redirect to after authorization. + :type redirect_uri: str + :param code: The authorization code. Applicable only for authorization code grant type. + :type code: str + :param username: The username of the user to authenticate. Applicable only for password grant type. + :type username: str + :param password: The password of the user to authenticate. Applicable only for password grant type. + :type password: str + :param asid_token: The ASID token. Applicable only for ASID token grant type. + :type asid_token: str + :param assertion: The SAML assertion. Applicable only for saml2-bearer grant type. + :type assertion: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._o_auth2_token_serialize( + grant_type=grant_type, + client_id=client_id, + client_secret=client_secret, + redirect_uri=redirect_uri, + code=code, + username=username, + password=password, + asid_token=asid_token, + assertion=assertion, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TokenResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def o_auth2_token_with_http_info( + self, + grant_type: Annotated[Optional[StrictStr], Field(description="The grant type. Supported values: - `authorization_code`: The authorization code grant type. - `password`: The password grant type. - `urn:ietf:params:oauth:grant-type:saml2-bearer`: The saml2-bearer grant type. - `urn:visier:params:oauth:grant-type:asid-token`: The ASID token grant type.")] = None, + client_id: Annotated[Optional[StrictStr], Field(description="The ID of the pre-registered client application.")] = None, + client_secret: Annotated[Optional[StrictStr], Field(description="The secret of the pre-registered client application.")] = None, + redirect_uri: Annotated[Optional[StrictStr], Field(description="The optional URI to redirect to after authorization.")] = None, + code: Annotated[Optional[StrictStr], Field(description="The authorization code. Applicable only for authorization code grant type.")] = None, + username: Annotated[Optional[StrictStr], Field(description="The username of the user to authenticate. Applicable only for password grant type.")] = None, + password: Annotated[Optional[StrictStr], Field(description="The password of the user to authenticate. Applicable only for password grant type.")] = None, + asid_token: Annotated[Optional[StrictStr], Field(description="The ASID token. Applicable only for ASID token grant type.")] = None, + assertion: Annotated[Optional[StrictStr], Field(description="The SAML assertion. Applicable only for saml2-bearer grant type.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TokenResponse]: + """Request a JSON Web Token + + Use an OAuth 2.0 grant type to request a JWT. + + :param grant_type: The grant type. Supported values: - `authorization_code`: The authorization code grant type. - `password`: The password grant type. - `urn:ietf:params:oauth:grant-type:saml2-bearer`: The saml2-bearer grant type. - `urn:visier:params:oauth:grant-type:asid-token`: The ASID token grant type. + :type grant_type: str + :param client_id: The ID of the pre-registered client application. + :type client_id: str + :param client_secret: The secret of the pre-registered client application. + :type client_secret: str + :param redirect_uri: The optional URI to redirect to after authorization. + :type redirect_uri: str + :param code: The authorization code. Applicable only for authorization code grant type. + :type code: str + :param username: The username of the user to authenticate. Applicable only for password grant type. + :type username: str + :param password: The password of the user to authenticate. Applicable only for password grant type. + :type password: str + :param asid_token: The ASID token. Applicable only for ASID token grant type. + :type asid_token: str + :param assertion: The SAML assertion. Applicable only for saml2-bearer grant type. + :type assertion: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._o_auth2_token_serialize( + grant_type=grant_type, + client_id=client_id, + client_secret=client_secret, + redirect_uri=redirect_uri, + code=code, + username=username, + password=password, + asid_token=asid_token, + assertion=assertion, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TokenResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def o_auth2_token_without_preload_content( + self, + grant_type: Annotated[Optional[StrictStr], Field(description="The grant type. Supported values: - `authorization_code`: The authorization code grant type. - `password`: The password grant type. - `urn:ietf:params:oauth:grant-type:saml2-bearer`: The saml2-bearer grant type. - `urn:visier:params:oauth:grant-type:asid-token`: The ASID token grant type.")] = None, + client_id: Annotated[Optional[StrictStr], Field(description="The ID of the pre-registered client application.")] = None, + client_secret: Annotated[Optional[StrictStr], Field(description="The secret of the pre-registered client application.")] = None, + redirect_uri: Annotated[Optional[StrictStr], Field(description="The optional URI to redirect to after authorization.")] = None, + code: Annotated[Optional[StrictStr], Field(description="The authorization code. Applicable only for authorization code grant type.")] = None, + username: Annotated[Optional[StrictStr], Field(description="The username of the user to authenticate. Applicable only for password grant type.")] = None, + password: Annotated[Optional[StrictStr], Field(description="The password of the user to authenticate. Applicable only for password grant type.")] = None, + asid_token: Annotated[Optional[StrictStr], Field(description="The ASID token. Applicable only for ASID token grant type.")] = None, + assertion: Annotated[Optional[StrictStr], Field(description="The SAML assertion. Applicable only for saml2-bearer grant type.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Request a JSON Web Token + + Use an OAuth 2.0 grant type to request a JWT. + + :param grant_type: The grant type. Supported values: - `authorization_code`: The authorization code grant type. - `password`: The password grant type. - `urn:ietf:params:oauth:grant-type:saml2-bearer`: The saml2-bearer grant type. - `urn:visier:params:oauth:grant-type:asid-token`: The ASID token grant type. + :type grant_type: str + :param client_id: The ID of the pre-registered client application. + :type client_id: str + :param client_secret: The secret of the pre-registered client application. + :type client_secret: str + :param redirect_uri: The optional URI to redirect to after authorization. + :type redirect_uri: str + :param code: The authorization code. Applicable only for authorization code grant type. + :type code: str + :param username: The username of the user to authenticate. Applicable only for password grant type. + :type username: str + :param password: The password of the user to authenticate. Applicable only for password grant type. + :type password: str + :param asid_token: The ASID token. Applicable only for ASID token grant type. + :type asid_token: str + :param assertion: The SAML assertion. Applicable only for saml2-bearer grant type. + :type assertion: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._o_auth2_token_serialize( + grant_type=grant_type, + client_id=client_id, + client_secret=client_secret, + redirect_uri=redirect_uri, + code=code, + username=username, + password=password, + asid_token=asid_token, + assertion=assertion, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TokenResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _o_auth2_token_serialize( + self, + grant_type, + client_id, + client_secret, + redirect_uri, + code, + username, + password, + asid_token, + assertion, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + if grant_type is not None: + _form_params.append(('grant_type', grant_type)) + if client_id is not None: + _form_params.append(('client_id', client_id)) + if client_secret is not None: + _form_params.append(('client_secret', client_secret)) + if redirect_uri is not None: + _form_params.append(('redirect_uri', redirect_uri)) + if code is not None: + _form_params.append(('code', code)) + if username is not None: + _form_params.append(('username', username)) + if password is not None: + _form_params.append(('password', password)) + if asid_token is not None: + _form_params.append(('asid_token', asid_token)) + if assertion is not None: + _form_params.append(('assertion', assertion)) + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/x-www-form-urlencoded' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/auth/oauth2/token', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def oauth2_authorize( + self, + response_type: Annotated[StrictStr, Field(description="The response type. Must be `code`.")], + client_id: Annotated[StrictStr, Field(description="The ID of the pre-registered client application.")], + redirect_uri: Annotated[Optional[StrictStr], Field(description="The optional URI to redirect to after authorization.")] = None, + scope: Annotated[Optional[StrictStr], Field(description="The OAuth 2.0 scope of the authorization request. Default is `read`. If the scope includes `visier:login:bypass_users`, then the redirect login URL ends in \"/auth/admin\" instead of \"/auth\". This allows single sign-on (SSO) Bypass Users to login through Visier instead of being redirected to the SSO login page.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> Status: + """Request an authorization code + + Request an authorization code for the authorization_code grant type. Not required in other OAuth 2.0 grant types. + + :param response_type: The response type. Must be `code`. (required) + :type response_type: str + :param client_id: The ID of the pre-registered client application. (required) + :type client_id: str + :param redirect_uri: The optional URI to redirect to after authorization. + :type redirect_uri: str + :param scope: The OAuth 2.0 scope of the authorization request. Default is `read`. If the scope includes `visier:login:bypass_users`, then the redirect login URL ends in \"/auth/admin\" instead of \"/auth\". This allows single sign-on (SSO) Bypass Users to login through Visier instead of being redirected to the SSO login page. + :type scope: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._oauth2_authorize_serialize( + response_type=response_type, + client_id=client_id, + redirect_uri=redirect_uri, + scope=scope, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '3XX': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def oauth2_authorize_with_http_info( + self, + response_type: Annotated[StrictStr, Field(description="The response type. Must be `code`.")], + client_id: Annotated[StrictStr, Field(description="The ID of the pre-registered client application.")], + redirect_uri: Annotated[Optional[StrictStr], Field(description="The optional URI to redirect to after authorization.")] = None, + scope: Annotated[Optional[StrictStr], Field(description="The OAuth 2.0 scope of the authorization request. Default is `read`. If the scope includes `visier:login:bypass_users`, then the redirect login URL ends in \"/auth/admin\" instead of \"/auth\". This allows single sign-on (SSO) Bypass Users to login through Visier instead of being redirected to the SSO login page.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[Status]: + """Request an authorization code + + Request an authorization code for the authorization_code grant type. Not required in other OAuth 2.0 grant types. + + :param response_type: The response type. Must be `code`. (required) + :type response_type: str + :param client_id: The ID of the pre-registered client application. (required) + :type client_id: str + :param redirect_uri: The optional URI to redirect to after authorization. + :type redirect_uri: str + :param scope: The OAuth 2.0 scope of the authorization request. Default is `read`. If the scope includes `visier:login:bypass_users`, then the redirect login URL ends in \"/auth/admin\" instead of \"/auth\". This allows single sign-on (SSO) Bypass Users to login through Visier instead of being redirected to the SSO login page. + :type scope: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._oauth2_authorize_serialize( + response_type=response_type, + client_id=client_id, + redirect_uri=redirect_uri, + scope=scope, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '3XX': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def oauth2_authorize_without_preload_content( + self, + response_type: Annotated[StrictStr, Field(description="The response type. Must be `code`.")], + client_id: Annotated[StrictStr, Field(description="The ID of the pre-registered client application.")], + redirect_uri: Annotated[Optional[StrictStr], Field(description="The optional URI to redirect to after authorization.")] = None, + scope: Annotated[Optional[StrictStr], Field(description="The OAuth 2.0 scope of the authorization request. Default is `read`. If the scope includes `visier:login:bypass_users`, then the redirect login URL ends in \"/auth/admin\" instead of \"/auth\". This allows single sign-on (SSO) Bypass Users to login through Visier instead of being redirected to the SSO login page.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Request an authorization code + + Request an authorization code for the authorization_code grant type. Not required in other OAuth 2.0 grant types. + + :param response_type: The response type. Must be `code`. (required) + :type response_type: str + :param client_id: The ID of the pre-registered client application. (required) + :type client_id: str + :param redirect_uri: The optional URI to redirect to after authorization. + :type redirect_uri: str + :param scope: The OAuth 2.0 scope of the authorization request. Default is `read`. If the scope includes `visier:login:bypass_users`, then the redirect login URL ends in \"/auth/admin\" instead of \"/auth\". This allows single sign-on (SSO) Bypass Users to login through Visier instead of being redirected to the SSO login page. + :type scope: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._oauth2_authorize_serialize( + response_type=response_type, + client_id=client_id, + redirect_uri=redirect_uri, + scope=scope, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '3XX': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _oauth2_authorize_serialize( + self, + response_type, + client_id, + redirect_uri, + scope, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if redirect_uri is not None: + + _query_params.append(('redirect_uri', redirect_uri)) + + if response_type is not None: + + _query_params.append(('response_type', response_type)) + + if client_id is not None: + + _query_params.append(('client_id', client_id)) + + if scope is not None: + + _query_params.append(('scope', scope)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/auth/oauth2/authorize', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def user_info( + self, + include_tenant_details: Annotated[Optional[StrictBool], Field(description="If `true`, includes tenant details in the response. Default is `false`.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AuthenticationOAuth2UserInfoDTO: + """Retrieve user-specific metadata + + Retrieve user-specific metadata, such as a user's ID, username, and profile capabilities. + + :param include_tenant_details: If `true`, includes tenant details in the response. Default is `false`. + :type include_tenant_details: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_info_serialize( + include_tenant_details=include_tenant_details, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AuthenticationOAuth2UserInfoDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_info_with_http_info( + self, + include_tenant_details: Annotated[Optional[StrictBool], Field(description="If `true`, includes tenant details in the response. Default is `false`.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AuthenticationOAuth2UserInfoDTO]: + """Retrieve user-specific metadata + + Retrieve user-specific metadata, such as a user's ID, username, and profile capabilities. + + :param include_tenant_details: If `true`, includes tenant details in the response. Default is `false`. + :type include_tenant_details: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_info_serialize( + include_tenant_details=include_tenant_details, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AuthenticationOAuth2UserInfoDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def user_info_without_preload_content( + self, + include_tenant_details: Annotated[Optional[StrictBool], Field(description="If `true`, includes tenant details in the response. Default is `false`.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve user-specific metadata + + Retrieve user-specific metadata, such as a user's ID, username, and profile capabilities. + + :param include_tenant_details: If `true`, includes tenant details in the response. Default is `false`. + :type include_tenant_details: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_info_serialize( + include_tenant_details=include_tenant_details, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AuthenticationOAuth2UserInfoDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _user_info_serialize( + self, + include_tenant_details, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if include_tenant_details is not None: + + _query_params.append(('includeTenantDetails', include_tenant_details)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/auth/oauth2/userinfo', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/object_configuration_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/object_configuration_api.py new file mode 100644 index 0000000000..cab954f860 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/object_configuration_api.py @@ -0,0 +1,1752 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.designer_api_calculation_concept_configuration_map_dto import DesignerApiCalculationConceptConfigurationMapDTO +from visier_platform_sdk.models.designer_api_calculation_concept_dto import DesignerApiCalculationConceptDTO +from visier_platform_sdk.models.designer_api_calculation_concept_list_dto import DesignerApiCalculationConceptListDTO +from visier_platform_sdk.models.designer_api_concept_configuration_result_dto import DesignerApiConceptConfigurationResultDTO +from visier_platform_sdk.models.designer_api_selection_concept_configuration_map_dto import DesignerApiSelectionConceptConfigurationMapDTO +from visier_platform_sdk.models.designer_api_selection_concept_dto import DesignerApiSelectionConceptDTO +from visier_platform_sdk.models.designer_api_selection_concept_list_dto import DesignerApiSelectionConceptListDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class ObjectConfigurationApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def get_calculation_concept( + self, + concept_id: Annotated[StrictStr, Field(description="The ID of the concept to retrieve the configuration for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerApiCalculationConceptDTO: + """Retrieve the configuration of a calculation concept + + Retrieve the configuration details of a calculation concept in production. + + :param concept_id: The ID of the concept to retrieve the configuration for. (required) + :type concept_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_calculation_concept_serialize( + concept_id=concept_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiCalculationConceptDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_calculation_concept_with_http_info( + self, + concept_id: Annotated[StrictStr, Field(description="The ID of the concept to retrieve the configuration for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerApiCalculationConceptDTO]: + """Retrieve the configuration of a calculation concept + + Retrieve the configuration details of a calculation concept in production. + + :param concept_id: The ID of the concept to retrieve the configuration for. (required) + :type concept_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_calculation_concept_serialize( + concept_id=concept_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiCalculationConceptDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_calculation_concept_without_preload_content( + self, + concept_id: Annotated[StrictStr, Field(description="The ID of the concept to retrieve the configuration for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the configuration of a calculation concept + + Retrieve the configuration details of a calculation concept in production. + + :param concept_id: The ID of the concept to retrieve the configuration for. (required) + :type concept_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_calculation_concept_serialize( + concept_id=concept_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiCalculationConceptDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_calculation_concept_serialize( + self, + concept_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if concept_id is not None: + _path_params['conceptId'] = concept_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/calculation-concepts/{conceptId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_calculation_concepts( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerApiCalculationConceptListDTO: + """Retrieve all calculation concepts + + Retrieve the calculation concepts available in production. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_calculation_concepts_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiCalculationConceptListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_calculation_concepts_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerApiCalculationConceptListDTO]: + """Retrieve all calculation concepts + + Retrieve the calculation concepts available in production. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_calculation_concepts_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiCalculationConceptListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_calculation_concepts_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve all calculation concepts + + Retrieve the calculation concepts available in production. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_calculation_concepts_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiCalculationConceptListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_calculation_concepts_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/calculation-concepts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_selection_concept( + self, + concept_id: Annotated[StrictStr, Field(description="The ID of the concept to retrieve the configuration for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerApiSelectionConceptDTO: + """Retrieve the configuration of a selection concept + + Retrieve the configuration details of a selection concept in production. + + :param concept_id: The ID of the concept to retrieve the configuration for. (required) + :type concept_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_selection_concept_serialize( + concept_id=concept_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiSelectionConceptDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_selection_concept_with_http_info( + self, + concept_id: Annotated[StrictStr, Field(description="The ID of the concept to retrieve the configuration for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerApiSelectionConceptDTO]: + """Retrieve the configuration of a selection concept + + Retrieve the configuration details of a selection concept in production. + + :param concept_id: The ID of the concept to retrieve the configuration for. (required) + :type concept_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_selection_concept_serialize( + concept_id=concept_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiSelectionConceptDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_selection_concept_without_preload_content( + self, + concept_id: Annotated[StrictStr, Field(description="The ID of the concept to retrieve the configuration for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the configuration of a selection concept + + Retrieve the configuration details of a selection concept in production. + + :param concept_id: The ID of the concept to retrieve the configuration for. (required) + :type concept_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_selection_concept_serialize( + concept_id=concept_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiSelectionConceptDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_selection_concept_serialize( + self, + concept_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if concept_id is not None: + _path_params['conceptId'] = concept_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/selection-concepts/{conceptId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_selection_concepts( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerApiSelectionConceptListDTO: + """Retrieve all selection concepts + + Retrieve the selection concepts available in production. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_selection_concepts_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiSelectionConceptListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_selection_concepts_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerApiSelectionConceptListDTO]: + """Retrieve all selection concepts + + Retrieve the selection concepts available in production. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_selection_concepts_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiSelectionConceptListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_selection_concepts_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve all selection concepts + + Retrieve the selection concepts available in production. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_selection_concepts_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiSelectionConceptListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_selection_concepts_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/selection-concepts', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def map_calculation_concept( + self, + concept_id: Annotated[StrictStr, Field(description="The UUID of the concept to configure.")], + designer_api_calculation_concept_configuration_map_dto: DesignerApiCalculationConceptConfigurationMapDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerApiConceptConfigurationResultDTO: + """Map dimension members to nodes in a calculation concept + + Map dimension members to nodes in a calculation concept. The changes are applied in a new project and published to production. The body of this API is the source of truth for dimension members mapped to the concept. For example, if a node in the body does not have any dimension members, all existing dimension members mapped to that node will be removed. + + :param concept_id: The UUID of the concept to configure. (required) + :type concept_id: str + :param designer_api_calculation_concept_configuration_map_dto: (required) + :type designer_api_calculation_concept_configuration_map_dto: DesignerApiCalculationConceptConfigurationMapDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._map_calculation_concept_serialize( + concept_id=concept_id, + designer_api_calculation_concept_configuration_map_dto=designer_api_calculation_concept_configuration_map_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiConceptConfigurationResultDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def map_calculation_concept_with_http_info( + self, + concept_id: Annotated[StrictStr, Field(description="The UUID of the concept to configure.")], + designer_api_calculation_concept_configuration_map_dto: DesignerApiCalculationConceptConfigurationMapDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerApiConceptConfigurationResultDTO]: + """Map dimension members to nodes in a calculation concept + + Map dimension members to nodes in a calculation concept. The changes are applied in a new project and published to production. The body of this API is the source of truth for dimension members mapped to the concept. For example, if a node in the body does not have any dimension members, all existing dimension members mapped to that node will be removed. + + :param concept_id: The UUID of the concept to configure. (required) + :type concept_id: str + :param designer_api_calculation_concept_configuration_map_dto: (required) + :type designer_api_calculation_concept_configuration_map_dto: DesignerApiCalculationConceptConfigurationMapDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._map_calculation_concept_serialize( + concept_id=concept_id, + designer_api_calculation_concept_configuration_map_dto=designer_api_calculation_concept_configuration_map_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiConceptConfigurationResultDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def map_calculation_concept_without_preload_content( + self, + concept_id: Annotated[StrictStr, Field(description="The UUID of the concept to configure.")], + designer_api_calculation_concept_configuration_map_dto: DesignerApiCalculationConceptConfigurationMapDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Map dimension members to nodes in a calculation concept + + Map dimension members to nodes in a calculation concept. The changes are applied in a new project and published to production. The body of this API is the source of truth for dimension members mapped to the concept. For example, if a node in the body does not have any dimension members, all existing dimension members mapped to that node will be removed. + + :param concept_id: The UUID of the concept to configure. (required) + :type concept_id: str + :param designer_api_calculation_concept_configuration_map_dto: (required) + :type designer_api_calculation_concept_configuration_map_dto: DesignerApiCalculationConceptConfigurationMapDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._map_calculation_concept_serialize( + concept_id=concept_id, + designer_api_calculation_concept_configuration_map_dto=designer_api_calculation_concept_configuration_map_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiConceptConfigurationResultDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _map_calculation_concept_serialize( + self, + concept_id, + designer_api_calculation_concept_configuration_map_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if concept_id is not None: + _path_params['conceptId'] = concept_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if designer_api_calculation_concept_configuration_map_dto is not None: + _body_params = designer_api_calculation_concept_configuration_map_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/calculation-concepts/{conceptId}/configure', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def map_selection_concept( + self, + concept_id: Annotated[StrictStr, Field(description="The UUID of the concept to configure.")], + designer_api_selection_concept_configuration_map_dto: DesignerApiSelectionConceptConfigurationMapDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerApiConceptConfigurationResultDTO: + """Map dimension members to a selection concept + + Map dimension members to a selection concept. The changes are applied to a new project and published to production. The body of this API is the source of truth for dimension members mapped to the concept. For example, if a node in the body does not have any dimension members, all existing dimension members mapped to that node will be removed. + + :param concept_id: The UUID of the concept to configure. (required) + :type concept_id: str + :param designer_api_selection_concept_configuration_map_dto: (required) + :type designer_api_selection_concept_configuration_map_dto: DesignerApiSelectionConceptConfigurationMapDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._map_selection_concept_serialize( + concept_id=concept_id, + designer_api_selection_concept_configuration_map_dto=designer_api_selection_concept_configuration_map_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiConceptConfigurationResultDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def map_selection_concept_with_http_info( + self, + concept_id: Annotated[StrictStr, Field(description="The UUID of the concept to configure.")], + designer_api_selection_concept_configuration_map_dto: DesignerApiSelectionConceptConfigurationMapDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerApiConceptConfigurationResultDTO]: + """Map dimension members to a selection concept + + Map dimension members to a selection concept. The changes are applied to a new project and published to production. The body of this API is the source of truth for dimension members mapped to the concept. For example, if a node in the body does not have any dimension members, all existing dimension members mapped to that node will be removed. + + :param concept_id: The UUID of the concept to configure. (required) + :type concept_id: str + :param designer_api_selection_concept_configuration_map_dto: (required) + :type designer_api_selection_concept_configuration_map_dto: DesignerApiSelectionConceptConfigurationMapDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._map_selection_concept_serialize( + concept_id=concept_id, + designer_api_selection_concept_configuration_map_dto=designer_api_selection_concept_configuration_map_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiConceptConfigurationResultDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def map_selection_concept_without_preload_content( + self, + concept_id: Annotated[StrictStr, Field(description="The UUID of the concept to configure.")], + designer_api_selection_concept_configuration_map_dto: DesignerApiSelectionConceptConfigurationMapDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Map dimension members to a selection concept + + Map dimension members to a selection concept. The changes are applied to a new project and published to production. The body of this API is the source of truth for dimension members mapped to the concept. For example, if a node in the body does not have any dimension members, all existing dimension members mapped to that node will be removed. + + :param concept_id: The UUID of the concept to configure. (required) + :type concept_id: str + :param designer_api_selection_concept_configuration_map_dto: (required) + :type designer_api_selection_concept_configuration_map_dto: DesignerApiSelectionConceptConfigurationMapDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._map_selection_concept_serialize( + concept_id=concept_id, + designer_api_selection_concept_configuration_map_dto=designer_api_selection_concept_configuration_map_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerApiConceptConfigurationResultDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _map_selection_concept_serialize( + self, + concept_id, + designer_api_selection_concept_configuration_map_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if concept_id is not None: + _path_params['conceptId'] = concept_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if designer_api_selection_concept_configuration_map_dto is not None: + _body_params = designer_api_selection_concept_configuration_map_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/selection-concepts/{conceptId}/configure', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/permissions_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/permissions_api.py new file mode 100644 index 0000000000..560ed50b86 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/permissions_api.py @@ -0,0 +1,4295 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr +from typing import List, Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_permissions_list_dto import AdminPermissionsListDTO +from visier_platform_sdk.models.servicing_bulk_data_access_set_response_dto import ServicingBulkDataAccessSetResponseDTO +from visier_platform_sdk.models.servicing_capability_dto import ServicingCapabilityDTO +from visier_platform_sdk.models.servicing_content_package_dto import ServicingContentPackageDTO +from visier_platform_sdk.models.servicing_create_data_access_set_request_dto import ServicingCreateDataAccessSetRequestDTO +from visier_platform_sdk.models.servicing_data_access_set_dto import ServicingDataAccessSetDTO +from visier_platform_sdk.models.servicing_delete_permissions_request_dto import ServicingDeletePermissionsRequestDTO +from visier_platform_sdk.models.servicing_get_capabilities_api_response_dto import ServicingGetCapabilitiesAPIResponseDTO +from visier_platform_sdk.models.servicing_get_content_packages_api_response_dto import ServicingGetContentPackagesAPIResponseDTO +from visier_platform_sdk.models.servicing_get_data_access_sets_api_response_dto import ServicingGetDataAccessSetsAPIResponseDTO +from visier_platform_sdk.models.servicing_get_data_security_objects_api_response_dto import ServicingGetDataSecurityObjectsAPIResponseDTO +from visier_platform_sdk.models.servicing_get_permissions_api_response_dto import ServicingGetPermissionsAPIResponseDTO +from visier_platform_sdk.models.servicing_permission_bulk_operation_response_dto import ServicingPermissionBulkOperationResponseDTO +from visier_platform_sdk.models.servicing_permission_dto import ServicingPermissionDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class PermissionsApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def create_data_access_sets( + self, + servicing_create_data_access_set_request_dto: ServicingCreateDataAccessSetRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingBulkDataAccessSetResponseDTO: + """Create shareable data access sets + + Create shareable data access sets. Shareable data access sets let you reuse common data access configurations in multiple permissions. To specify the project in which to create shareable data access sets, provide a project UUID in the `ProjectID` request header. + + :param servicing_create_data_access_set_request_dto: (required) + :type servicing_create_data_access_set_request_dto: ServicingCreateDataAccessSetRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_data_access_sets_serialize( + servicing_create_data_access_set_request_dto=servicing_create_data_access_set_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingBulkDataAccessSetResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_data_access_sets_with_http_info( + self, + servicing_create_data_access_set_request_dto: ServicingCreateDataAccessSetRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingBulkDataAccessSetResponseDTO]: + """Create shareable data access sets + + Create shareable data access sets. Shareable data access sets let you reuse common data access configurations in multiple permissions. To specify the project in which to create shareable data access sets, provide a project UUID in the `ProjectID` request header. + + :param servicing_create_data_access_set_request_dto: (required) + :type servicing_create_data_access_set_request_dto: ServicingCreateDataAccessSetRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_data_access_sets_serialize( + servicing_create_data_access_set_request_dto=servicing_create_data_access_set_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingBulkDataAccessSetResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_data_access_sets_without_preload_content( + self, + servicing_create_data_access_set_request_dto: ServicingCreateDataAccessSetRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create shareable data access sets + + Create shareable data access sets. Shareable data access sets let you reuse common data access configurations in multiple permissions. To specify the project in which to create shareable data access sets, provide a project UUID in the `ProjectID` request header. + + :param servicing_create_data_access_set_request_dto: (required) + :type servicing_create_data_access_set_request_dto: ServicingCreateDataAccessSetRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_data_access_sets_serialize( + servicing_create_data_access_set_request_dto=servicing_create_data_access_set_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingBulkDataAccessSetResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_data_access_sets_serialize( + self, + servicing_create_data_access_set_request_dto, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if servicing_create_data_access_set_request_dto is not None: + _body_params = servicing_create_data_access_set_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/data-access-sets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def create_permissions( + self, + admin_permissions_list_dto: AdminPermissionsListDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create permissions in.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingPermissionBulkOperationResponseDTO: + """Create permissions + + Create new permissions. Administrating tenant users can specify the tenant in which to add these permissions. To specify the project in which to create permissions, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_list_dto: (required) + :type admin_permissions_list_dto: AdminPermissionsListDTO + :param tenant_code: Specify the tenant to create permissions in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_permissions_serialize( + admin_permissions_list_dto=admin_permissions_list_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionBulkOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_permissions_with_http_info( + self, + admin_permissions_list_dto: AdminPermissionsListDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create permissions in.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingPermissionBulkOperationResponseDTO]: + """Create permissions + + Create new permissions. Administrating tenant users can specify the tenant in which to add these permissions. To specify the project in which to create permissions, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_list_dto: (required) + :type admin_permissions_list_dto: AdminPermissionsListDTO + :param tenant_code: Specify the tenant to create permissions in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_permissions_serialize( + admin_permissions_list_dto=admin_permissions_list_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionBulkOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_permissions_without_preload_content( + self, + admin_permissions_list_dto: AdminPermissionsListDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create permissions in.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create permissions + + Create new permissions. Administrating tenant users can specify the tenant in which to add these permissions. To specify the project in which to create permissions, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_list_dto: (required) + :type admin_permissions_list_dto: AdminPermissionsListDTO + :param tenant_code: Specify the tenant to create permissions in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_permissions_serialize( + admin_permissions_list_dto=admin_permissions_list_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionBulkOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_permissions_serialize( + self, + admin_permissions_list_dto, + tenant_code, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if admin_permissions_list_dto is not None: + _body_params = admin_permissions_list_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_permissions( + self, + servicing_delete_permissions_request_dto: ServicingDeletePermissionsRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete permissions from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingPermissionBulkOperationResponseDTO: + """Delete permissions + + Delete existing permissions. To specify the project in which to delete permissions, provide a project UUID in the `ProjectID` request header. + + :param servicing_delete_permissions_request_dto: (required) + :type servicing_delete_permissions_request_dto: ServicingDeletePermissionsRequestDTO + :param tenant_code: Specify the tenant to delete permissions from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_permissions_serialize( + servicing_delete_permissions_request_dto=servicing_delete_permissions_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionBulkOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_permissions_with_http_info( + self, + servicing_delete_permissions_request_dto: ServicingDeletePermissionsRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete permissions from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingPermissionBulkOperationResponseDTO]: + """Delete permissions + + Delete existing permissions. To specify the project in which to delete permissions, provide a project UUID in the `ProjectID` request header. + + :param servicing_delete_permissions_request_dto: (required) + :type servicing_delete_permissions_request_dto: ServicingDeletePermissionsRequestDTO + :param tenant_code: Specify the tenant to delete permissions from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_permissions_serialize( + servicing_delete_permissions_request_dto=servicing_delete_permissions_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionBulkOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_permissions_without_preload_content( + self, + servicing_delete_permissions_request_dto: ServicingDeletePermissionsRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete permissions from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete permissions + + Delete existing permissions. To specify the project in which to delete permissions, provide a project UUID in the `ProjectID` request header. + + :param servicing_delete_permissions_request_dto: (required) + :type servicing_delete_permissions_request_dto: ServicingDeletePermissionsRequestDTO + :param tenant_code: Specify the tenant to delete permissions from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_permissions_serialize( + servicing_delete_permissions_request_dto=servicing_delete_permissions_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionBulkOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_permissions_serialize( + self, + servicing_delete_permissions_request_dto, + tenant_code, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + if servicing_delete_permissions_request_dto is not None: + _body_params = servicing_delete_permissions_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/admin/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_capabilities( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the capabilities from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingGetCapabilitiesAPIResponseDTO: + """Retrieve a list of all permission capabilities + + Retrieve all the permission capabilities in your tenant. You can use the returned capabilities in other API calls when creating or updating permissions to assign the capability to the permission. To specify the project in which to retrieve the permission capabilities, provide a project UUID in the `ProjectID` request header. + + :param tenant_code: Specify the tenant to retrieve the capabilities from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_capabilities_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetCapabilitiesAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_capabilities_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the capabilities from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingGetCapabilitiesAPIResponseDTO]: + """Retrieve a list of all permission capabilities + + Retrieve all the permission capabilities in your tenant. You can use the returned capabilities in other API calls when creating or updating permissions to assign the capability to the permission. To specify the project in which to retrieve the permission capabilities, provide a project UUID in the `ProjectID` request header. + + :param tenant_code: Specify the tenant to retrieve the capabilities from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_capabilities_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetCapabilitiesAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_capabilities_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the capabilities from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all permission capabilities + + Retrieve all the permission capabilities in your tenant. You can use the returned capabilities in other API calls when creating or updating permissions to assign the capability to the permission. To specify the project in which to retrieve the permission capabilities, provide a project UUID in the `ProjectID` request header. + + :param tenant_code: Specify the tenant to retrieve the capabilities from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_capabilities_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetCapabilitiesAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_capabilities_serialize( + self, + tenant_code, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/capabilities', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_capability( + self, + capability_id: Annotated[StrictStr, Field(description="The unique identifier of the capability you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a capability from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingCapabilityDTO: + """Retrieve a permission capability's details + + Retrieve the details of a specific capability. To specify the project in which to retrieve the permission capability, provide a project UUID in the `ProjectID` request header. + + :param capability_id: The unique identifier of the capability you want to retrieve. (required) + :type capability_id: str + :param tenant_code: Specify the tenant to retrieve a capability from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_capability_serialize( + capability_id=capability_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingCapabilityDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_capability_with_http_info( + self, + capability_id: Annotated[StrictStr, Field(description="The unique identifier of the capability you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a capability from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingCapabilityDTO]: + """Retrieve a permission capability's details + + Retrieve the details of a specific capability. To specify the project in which to retrieve the permission capability, provide a project UUID in the `ProjectID` request header. + + :param capability_id: The unique identifier of the capability you want to retrieve. (required) + :type capability_id: str + :param tenant_code: Specify the tenant to retrieve a capability from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_capability_serialize( + capability_id=capability_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingCapabilityDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_capability_without_preload_content( + self, + capability_id: Annotated[StrictStr, Field(description="The unique identifier of the capability you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a capability from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a permission capability's details + + Retrieve the details of a specific capability. To specify the project in which to retrieve the permission capability, provide a project UUID in the `ProjectID` request header. + + :param capability_id: The unique identifier of the capability you want to retrieve. (required) + :type capability_id: str + :param tenant_code: Specify the tenant to retrieve a capability from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_capability_serialize( + capability_id=capability_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingCapabilityDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_capability_serialize( + self, + capability_id, + tenant_code, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if capability_id is not None: + _path_params['capabilityId'] = capability_id + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/capabilities/{capabilityId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_content_package( + self, + content_package_id: Annotated[StrictStr, Field(description="The unique identifier of the content package you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a content package from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingContentPackageDTO: + """Retrieve a content package's details + + Retrieve the details of a specific content package. To specify the project in which to retrieve a content package, provide a project UUID in the `ProjectID` request header. + + :param content_package_id: The unique identifier of the content package you want to retrieve. (required) + :type content_package_id: str + :param tenant_code: Specify the tenant to retrieve a content package from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_content_package_serialize( + content_package_id=content_package_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingContentPackageDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_content_package_with_http_info( + self, + content_package_id: Annotated[StrictStr, Field(description="The unique identifier of the content package you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a content package from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingContentPackageDTO]: + """Retrieve a content package's details + + Retrieve the details of a specific content package. To specify the project in which to retrieve a content package, provide a project UUID in the `ProjectID` request header. + + :param content_package_id: The unique identifier of the content package you want to retrieve. (required) + :type content_package_id: str + :param tenant_code: Specify the tenant to retrieve a content package from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_content_package_serialize( + content_package_id=content_package_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingContentPackageDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_content_package_without_preload_content( + self, + content_package_id: Annotated[StrictStr, Field(description="The unique identifier of the content package you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a content package from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a content package's details + + Retrieve the details of a specific content package. To specify the project in which to retrieve a content package, provide a project UUID in the `ProjectID` request header. + + :param content_package_id: The unique identifier of the content package you want to retrieve. (required) + :type content_package_id: str + :param tenant_code: Specify the tenant to retrieve a content package from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_content_package_serialize( + content_package_id=content_package_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingContentPackageDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_content_package_serialize( + self, + content_package_id, + tenant_code, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if content_package_id is not None: + _path_params['contentPackageId'] = content_package_id + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/content-packages/{contentPackageId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_content_packages( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the content packages from.")] = None, + search_string: Annotated[Optional[StrictStr], Field(description="Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingGetContentPackagesAPIResponseDTO: + """Retrieve a list of all content packages + + Retrieve the list of available content packages. You can use the returned content packages in other API calls when creating or updating permissions to add the content package to the permission. To specify the project in which to retrieve the available content packages, provide a project UUID in the `ProjectID` request header. + + :param tenant_code: Specify the tenant to retrieve the content packages from. + :type tenant_code: str + :param search_string: Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages. + :type search_string: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_content_packages_serialize( + tenant_code=tenant_code, + search_string=search_string, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetContentPackagesAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_content_packages_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the content packages from.")] = None, + search_string: Annotated[Optional[StrictStr], Field(description="Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingGetContentPackagesAPIResponseDTO]: + """Retrieve a list of all content packages + + Retrieve the list of available content packages. You can use the returned content packages in other API calls when creating or updating permissions to add the content package to the permission. To specify the project in which to retrieve the available content packages, provide a project UUID in the `ProjectID` request header. + + :param tenant_code: Specify the tenant to retrieve the content packages from. + :type tenant_code: str + :param search_string: Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages. + :type search_string: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_content_packages_serialize( + tenant_code=tenant_code, + search_string=search_string, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetContentPackagesAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_content_packages_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the content packages from.")] = None, + search_string: Annotated[Optional[StrictStr], Field(description="Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all content packages + + Retrieve the list of available content packages. You can use the returned content packages in other API calls when creating or updating permissions to add the content package to the permission. To specify the project in which to retrieve the available content packages, provide a project UUID in the `ProjectID` request header. + + :param tenant_code: Specify the tenant to retrieve the content packages from. + :type tenant_code: str + :param search_string: Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, the response returns a list of all content packages. + :type search_string: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_content_packages_serialize( + tenant_code=tenant_code, + search_string=search_string, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetContentPackagesAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_content_packages_serialize( + self, + tenant_code, + search_string, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if search_string is not None: + + _query_params.append(('searchString', search_string)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/content-packages', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_data_access_set( + self, + data_access_set_id: Annotated[StrictStr, Field(description="The unique identifier of the data access set you want to retrieve.")], + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingDataAccessSetDTO: + """Retrieve a data access set's details + + Retrieve the details of a specific shareable data access set. You must know the ID of the data access set to retrieve its details. To retrieve data access set IDs, see `GET v1/admin/data-access-sets`. To specify the project in which to retrieve the shareable data access set, provide a project UUID in the `ProjectID` request header. + + :param data_access_set_id: The unique identifier of the data access set you want to retrieve. (required) + :type data_access_set_id: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_access_set_serialize( + data_access_set_id=data_access_set_id, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDataAccessSetDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_access_set_with_http_info( + self, + data_access_set_id: Annotated[StrictStr, Field(description="The unique identifier of the data access set you want to retrieve.")], + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingDataAccessSetDTO]: + """Retrieve a data access set's details + + Retrieve the details of a specific shareable data access set. You must know the ID of the data access set to retrieve its details. To retrieve data access set IDs, see `GET v1/admin/data-access-sets`. To specify the project in which to retrieve the shareable data access set, provide a project UUID in the `ProjectID` request header. + + :param data_access_set_id: The unique identifier of the data access set you want to retrieve. (required) + :type data_access_set_id: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_access_set_serialize( + data_access_set_id=data_access_set_id, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDataAccessSetDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_data_access_set_without_preload_content( + self, + data_access_set_id: Annotated[StrictStr, Field(description="The unique identifier of the data access set you want to retrieve.")], + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a data access set's details + + Retrieve the details of a specific shareable data access set. You must know the ID of the data access set to retrieve its details. To retrieve data access set IDs, see `GET v1/admin/data-access-sets`. To specify the project in which to retrieve the shareable data access set, provide a project UUID in the `ProjectID` request header. + + :param data_access_set_id: The unique identifier of the data access set you want to retrieve. (required) + :type data_access_set_id: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_access_set_serialize( + data_access_set_id=data_access_set_id, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingDataAccessSetDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_data_access_set_serialize( + self, + data_access_set_id, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if data_access_set_id is not None: + _path_params['dataAccessSetId'] = data_access_set_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/data-access-sets/{dataAccessSetId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_data_access_sets( + self, + analytic_object_id: Annotated[Optional[StrictStr], Field(description="Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects.")] = None, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of data access sets to return. Default is 100. Maximum is 1000.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingGetDataAccessSetsAPIResponseDTO: + """Retrieve a list of all data access sets + + Retrieve a list of all shareable data access sets. Data access sets define the level of access that users have to properties and property values for the analytic object in a permission. Data access sets also grant access to properties of subjects that are referenced by the analytic object in the permission. You can assign data access sets to a permission when creating or updating permissions. To specify the project in which to retrieve the shareable data access sets, provide a project UUID in the `ProjectID` request header. **Note:** If the number of valid data access sets exceeds the default limit of 100, the response status code is 206. To retrieve more than 100 data access sets, set `limit` to a higher number. + + :param analytic_object_id: Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects. + :type analytic_object_id: str + :param var_with: The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`). + :type var_with: List[str] + :param limit: The maximum number of data access sets to return. Default is 100. Maximum is 1000. + :type limit: int + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_access_sets_serialize( + analytic_object_id=analytic_object_id, + var_with=var_with, + limit=limit, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetDataAccessSetsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_access_sets_with_http_info( + self, + analytic_object_id: Annotated[Optional[StrictStr], Field(description="Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects.")] = None, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of data access sets to return. Default is 100. Maximum is 1000.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingGetDataAccessSetsAPIResponseDTO]: + """Retrieve a list of all data access sets + + Retrieve a list of all shareable data access sets. Data access sets define the level of access that users have to properties and property values for the analytic object in a permission. Data access sets also grant access to properties of subjects that are referenced by the analytic object in the permission. You can assign data access sets to a permission when creating or updating permissions. To specify the project in which to retrieve the shareable data access sets, provide a project UUID in the `ProjectID` request header. **Note:** If the number of valid data access sets exceeds the default limit of 100, the response status code is 206. To retrieve more than 100 data access sets, set `limit` to a higher number. + + :param analytic_object_id: Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects. + :type analytic_object_id: str + :param var_with: The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`). + :type var_with: List[str] + :param limit: The maximum number of data access sets to return. Default is 100. Maximum is 1000. + :type limit: int + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_access_sets_serialize( + analytic_object_id=analytic_object_id, + var_with=var_with, + limit=limit, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetDataAccessSetsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_data_access_sets_without_preload_content( + self, + analytic_object_id: Annotated[Optional[StrictStr], Field(description="Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects.")] = None, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of data access sets to return. Default is 100. Maximum is 1000.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all data access sets + + Retrieve a list of all shareable data access sets. Data access sets define the level of access that users have to properties and property values for the analytic object in a permission. Data access sets also grant access to properties of subjects that are referenced by the analytic object in the permission. You can assign data access sets to a permission when creating or updating permissions. To specify the project in which to retrieve the shareable data access sets, provide a project UUID in the `ProjectID` request header. **Note:** If the number of valid data access sets exceeds the default limit of 100, the response status code is 206. To retrieve more than 100 data access sets, set `limit` to a higher number. + + :param analytic_object_id: Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects. + :type analytic_object_id: str + :param var_with: The information about the data access set to include in the request response. * If empty, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID. * If `details`, returns basic information and property data access information (`propertyAccessConfigs`). + :type var_with: List[str] + :param limit: The maximum number of data access sets to return. Default is 100. Maximum is 1000. + :type limit: int + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_access_sets_serialize( + analytic_object_id=analytic_object_id, + var_with=var_with, + limit=limit, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetDataAccessSetsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_data_access_sets_serialize( + self, + analytic_object_id, + var_with, + limit, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'with': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if analytic_object_id is not None: + + _query_params.append(('analyticObjectId', analytic_object_id)) + + if var_with is not None: + + _query_params.append(('with', var_with)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/data-access-sets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_data_security_objects( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.")] = None, + include_details: Annotated[Optional[StrictBool], Field(description="If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve data security objects from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingGetDataSecurityObjectsAPIResponseDTO: + """Retrieve a list of data security objects + + Retrieve the list of available data security objects. Data security objects are analytic objects and their related objects that are available to define permissions' data security profiles. To specify the project in which to retrieve the available data security objects, provide a project UUID in the `ProjectID` request header. + + :param id: The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects. + :type id: List[str] + :param include_details: If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`. + :type include_details: bool + :param tenant_code: Specify the tenant to retrieve data security objects from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_security_objects_serialize( + id=id, + include_details=include_details, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetDataSecurityObjectsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_security_objects_with_http_info( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.")] = None, + include_details: Annotated[Optional[StrictBool], Field(description="If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve data security objects from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingGetDataSecurityObjectsAPIResponseDTO]: + """Retrieve a list of data security objects + + Retrieve the list of available data security objects. Data security objects are analytic objects and their related objects that are available to define permissions' data security profiles. To specify the project in which to retrieve the available data security objects, provide a project UUID in the `ProjectID` request header. + + :param id: The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects. + :type id: List[str] + :param include_details: If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`. + :type include_details: bool + :param tenant_code: Specify the tenant to retrieve data security objects from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_security_objects_serialize( + id=id, + include_details=include_details, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetDataSecurityObjectsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_data_security_objects_without_preload_content( + self, + id: Annotated[Optional[List[StrictStr]], Field(description="The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.")] = None, + include_details: Annotated[Optional[StrictBool], Field(description="If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve data security objects from.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of data security objects + + Retrieve the list of available data security objects. Data security objects are analytic objects and their related objects that are available to define permissions' data security profiles. To specify the project in which to retrieve the available data security objects, provide a project UUID in the `ProjectID` request header. + + :param id: The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects. + :type id: List[str] + :param include_details: If `true`, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If `false`, the response only includes analytic objects (display name, ID, and object type). Default is `false`. + :type include_details: bool + :param tenant_code: Specify the tenant to retrieve data security objects from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_security_objects_serialize( + id=id, + include_details=include_details, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetDataSecurityObjectsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_data_security_objects_serialize( + self, + id, + include_details, + tenant_code, + target_tenant_id, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'id': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if id is not None: + + _query_params.append(('id', id)) + + if include_details is not None: + + _query_params.append(('includeDetails', include_details)) + + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/data-security-objects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_permission( + self, + permission_id: Annotated[StrictStr, Field(description="The unique identifier of the permission you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a permission from.")] = None, + include_details_with_status: Annotated[Optional[StrictStr], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingPermissionDTO: + """Retrieve a permission's details + + Retrieve the details for a specified permission. To specify the project in which to retrieve the permission, provide a project UUID in the `ProjectID` request header. + + :param permission_id: The unique identifier of the permission you want to retrieve. (required) + :type permission_id: str + :param tenant_code: Specify the tenant to retrieve a permission from. + :type tenant_code: str + :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`. + :type include_details_with_status: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_permission_serialize( + permission_id=permission_id, + tenant_code=tenant_code, + include_details_with_status=include_details_with_status, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_permission_with_http_info( + self, + permission_id: Annotated[StrictStr, Field(description="The unique identifier of the permission you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a permission from.")] = None, + include_details_with_status: Annotated[Optional[StrictStr], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingPermissionDTO]: + """Retrieve a permission's details + + Retrieve the details for a specified permission. To specify the project in which to retrieve the permission, provide a project UUID in the `ProjectID` request header. + + :param permission_id: The unique identifier of the permission you want to retrieve. (required) + :type permission_id: str + :param tenant_code: Specify the tenant to retrieve a permission from. + :type tenant_code: str + :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`. + :type include_details_with_status: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_permission_serialize( + permission_id=permission_id, + tenant_code=tenant_code, + include_details_with_status=include_details_with_status, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_permission_without_preload_content( + self, + permission_id: Annotated[StrictStr, Field(description="The unique identifier of the permission you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a permission from.")] = None, + include_details_with_status: Annotated[Optional[StrictStr], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a permission's details + + Retrieve the details for a specified permission. To specify the project in which to retrieve the permission, provide a project UUID in the `ProjectID` request header. + + :param permission_id: The unique identifier of the permission you want to retrieve. (required) + :type permission_id: str + :param tenant_code: Specify the tenant to retrieve a permission from. + :type tenant_code: str + :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`. + :type include_details_with_status: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_permission_serialize( + permission_id=permission_id, + tenant_code=tenant_code, + include_details_with_status=include_details_with_status, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_permission_serialize( + self, + permission_id, + tenant_code, + include_details_with_status, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if permission_id is not None: + _path_params['permissionId'] = permission_id + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if include_details_with_status is not None: + + _query_params.append(('includeDetailsWithStatus', include_details_with_status)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/permissions/{permissionId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_permissions( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the permissions from.")] = None, + include_details: Annotated[Optional[StrictBool], Field(description="If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`.")] = None, + include_details_with_status: Annotated[Optional[StrictBool], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingGetPermissionsAPIResponseDTO: + """Retrieve a list of all permissions + + Retrieve the full list of user permissions in your tenant. To specify the project in which to retrieve permissions, provide a project UUID in the `ProjectID` request header. + + :param tenant_code: Specify the tenant to retrieve the permissions from. + :type tenant_code: str + :param include_details: If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`. + :type include_details: bool + :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`. + :type include_details_with_status: bool + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_permissions_serialize( + tenant_code=tenant_code, + include_details=include_details, + include_details_with_status=include_details_with_status, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetPermissionsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_permissions_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the permissions from.")] = None, + include_details: Annotated[Optional[StrictBool], Field(description="If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`.")] = None, + include_details_with_status: Annotated[Optional[StrictBool], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingGetPermissionsAPIResponseDTO]: + """Retrieve a list of all permissions + + Retrieve the full list of user permissions in your tenant. To specify the project in which to retrieve permissions, provide a project UUID in the `ProjectID` request header. + + :param tenant_code: Specify the tenant to retrieve the permissions from. + :type tenant_code: str + :param include_details: If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`. + :type include_details: bool + :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`. + :type include_details_with_status: bool + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_permissions_serialize( + tenant_code=tenant_code, + include_details=include_details, + include_details_with_status=include_details_with_status, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetPermissionsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_permissions_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the permissions from.")] = None, + include_details: Annotated[Optional[StrictBool], Field(description="If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`.")] = None, + include_details_with_status: Annotated[Optional[StrictBool], Field(description="If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all permissions + + Retrieve the full list of user permissions in your tenant. To specify the project in which to retrieve permissions, provide a project UUID in the `ProjectID` request header. + + :param tenant_code: Specify the tenant to retrieve the permissions from. + :type tenant_code: str + :param include_details: If `true`, returns the permission's details. If `false`, only returns the permissions' ID, display name, and description. Default is `false`. + :type include_details: bool + :param include_details_with_status: If `true`, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If `false`, doesn't return validity status information. Default is `false`. + :type include_details_with_status: bool + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_permissions_serialize( + tenant_code=tenant_code, + include_details=include_details, + include_details_with_status=include_details_with_status, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetPermissionsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_permissions_serialize( + self, + tenant_code, + include_details, + include_details_with_status, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if include_details is not None: + + _query_params.append(('includeDetails', include_details)) + + if include_details_with_status is not None: + + _query_params.append(('includeDetailsWithStatus', include_details_with_status)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_permissions( + self, + admin_permissions_list_dto: AdminPermissionsListDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update permissions in.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingPermissionBulkOperationResponseDTO: + """Update permissions + + Update existing permissions. To specify the project in which to update permissions, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_list_dto: (required) + :type admin_permissions_list_dto: AdminPermissionsListDTO + :param tenant_code: Specify the tenant to update permissions in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_permissions_serialize( + admin_permissions_list_dto=admin_permissions_list_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionBulkOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_permissions_with_http_info( + self, + admin_permissions_list_dto: AdminPermissionsListDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update permissions in.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingPermissionBulkOperationResponseDTO]: + """Update permissions + + Update existing permissions. To specify the project in which to update permissions, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_list_dto: (required) + :type admin_permissions_list_dto: AdminPermissionsListDTO + :param tenant_code: Specify the tenant to update permissions in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_permissions_serialize( + admin_permissions_list_dto=admin_permissions_list_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionBulkOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_permissions_without_preload_content( + self, + admin_permissions_list_dto: AdminPermissionsListDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update permissions in.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update permissions + + Update existing permissions. To specify the project in which to update permissions, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_list_dto: (required) + :type admin_permissions_list_dto: AdminPermissionsListDTO + :param tenant_code: Specify the tenant to update permissions in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_permissions_serialize( + admin_permissions_list_dto=admin_permissions_list_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionBulkOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_permissions_serialize( + self, + admin_permissions_list_dto, + tenant_code, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if admin_permissions_list_dto is not None: + _body_params = admin_permissions_list_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/pgp_key_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/pgp_key_api.py new file mode 100644 index 0000000000..671e1329c8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/pgp_key_api.py @@ -0,0 +1,1161 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.designer_crypto_key_pair_delete_response_dto import DesignerCryptoKeyPairDeleteResponseDTO +from visier_platform_sdk.models.designer_crypto_key_pair_generate_request_dto import DesignerCryptoKeyPairGenerateRequestDTO +from visier_platform_sdk.models.designer_crypto_public_key_dto import DesignerCryptoPublicKeyDTO +from visier_platform_sdk.models.designer_crypto_public_keys_dto import DesignerCryptoPublicKeysDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class PGPKeyApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def delete_pgp_key_pair( + self, + key_id: Annotated[StrictStr, Field(description="The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerCryptoKeyPairDeleteResponseDTO: + """Delete a PGP key pair + + Delete a PGP key pair using a key ID. + + :param key_id: The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros. (required) + :type key_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_pgp_key_pair_serialize( + key_id=key_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoKeyPairDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_pgp_key_pair_with_http_info( + self, + key_id: Annotated[StrictStr, Field(description="The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerCryptoKeyPairDeleteResponseDTO]: + """Delete a PGP key pair + + Delete a PGP key pair using a key ID. + + :param key_id: The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros. (required) + :type key_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_pgp_key_pair_serialize( + key_id=key_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoKeyPairDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_pgp_key_pair_without_preload_content( + self, + key_id: Annotated[StrictStr, Field(description="The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a PGP key pair + + Delete a PGP key pair using a key ID. + + :param key_id: The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros. (required) + :type key_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_pgp_key_pair_serialize( + key_id=key_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoKeyPairDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_pgp_key_pair_serialize( + self, + key_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if key_id is not None: + _path_params['keyID'] = key_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/api/pgpkey/{keyID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def generate_pgp_key_pair( + self, + designer_crypto_key_pair_generate_request_dto: DesignerCryptoKeyPairGenerateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerCryptoPublicKeyDTO: + """Download a public encryption key + + Generate a key pair and retrieve the public key that you can use to encrypt your data to send to Visier. In the request body, optionally set the UTC expiration date for the key pair in ISO-8601 format. Must be between 2 and 10 years. Default is 2 years. + + :param designer_crypto_key_pair_generate_request_dto: (required) + :type designer_crypto_key_pair_generate_request_dto: DesignerCryptoKeyPairGenerateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_pgp_key_pair_serialize( + designer_crypto_key_pair_generate_request_dto=designer_crypto_key_pair_generate_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoPublicKeyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def generate_pgp_key_pair_with_http_info( + self, + designer_crypto_key_pair_generate_request_dto: DesignerCryptoKeyPairGenerateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerCryptoPublicKeyDTO]: + """Download a public encryption key + + Generate a key pair and retrieve the public key that you can use to encrypt your data to send to Visier. In the request body, optionally set the UTC expiration date for the key pair in ISO-8601 format. Must be between 2 and 10 years. Default is 2 years. + + :param designer_crypto_key_pair_generate_request_dto: (required) + :type designer_crypto_key_pair_generate_request_dto: DesignerCryptoKeyPairGenerateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_pgp_key_pair_serialize( + designer_crypto_key_pair_generate_request_dto=designer_crypto_key_pair_generate_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoPublicKeyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def generate_pgp_key_pair_without_preload_content( + self, + designer_crypto_key_pair_generate_request_dto: DesignerCryptoKeyPairGenerateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Download a public encryption key + + Generate a key pair and retrieve the public key that you can use to encrypt your data to send to Visier. In the request body, optionally set the UTC expiration date for the key pair in ISO-8601 format. Must be between 2 and 10 years. Default is 2 years. + + :param designer_crypto_key_pair_generate_request_dto: (required) + :type designer_crypto_key_pair_generate_request_dto: DesignerCryptoKeyPairGenerateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._generate_pgp_key_pair_serialize( + designer_crypto_key_pair_generate_request_dto=designer_crypto_key_pair_generate_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoPublicKeyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _generate_pgp_key_pair_serialize( + self, + designer_crypto_key_pair_generate_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if designer_crypto_key_pair_generate_request_dto is not None: + _body_params = designer_crypto_key_pair_generate_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/api/pgpkey', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_pgp_public_keys( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerCryptoPublicKeysDTO: + """Retrieve all PGP public keys + + Retrieve a list of all PGP public keys in your tenant. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_pgp_public_keys_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoPublicKeysDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_pgp_public_keys_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerCryptoPublicKeysDTO]: + """Retrieve all PGP public keys + + Retrieve a list of all PGP public keys in your tenant. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_pgp_public_keys_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoPublicKeysDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_pgp_public_keys_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve all PGP public keys + + Retrieve a list of all PGP public keys in your tenant. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_pgp_public_keys_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoPublicKeysDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_pgp_public_keys_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/api/pgpkey', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_pgp_public_key( + self, + key_id: Annotated[StrictStr, Field(description="The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerCryptoPublicKeyDTO: + """Retrieve a PGP public key using the key ID + + If you know your PGP key ID, use it to retrieve the PGP public key. To get a list of all key IDs, see `Retrieve all PGP public keys`. + + :param key_id: The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros. (required) + :type key_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_pgp_public_key_serialize( + key_id=key_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoPublicKeyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_pgp_public_key_with_http_info( + self, + key_id: Annotated[StrictStr, Field(description="The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerCryptoPublicKeyDTO]: + """Retrieve a PGP public key using the key ID + + If you know your PGP key ID, use it to retrieve the PGP public key. To get a list of all key IDs, see `Retrieve all PGP public keys`. + + :param key_id: The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros. (required) + :type key_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_pgp_public_key_serialize( + key_id=key_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoPublicKeyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_pgp_public_key_without_preload_content( + self, + key_id: Annotated[StrictStr, Field(description="The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a PGP public key using the key ID + + If you know your PGP key ID, use it to retrieve the PGP public key. To get a list of all key IDs, see `Retrieve all PGP public keys`. + + :param key_id: The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros. (required) + :type key_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_pgp_public_key_serialize( + key_id=key_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerCryptoPublicKeyDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_pgp_public_key_serialize( + self, + key_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if key_id is not None: + _path_params['keyID'] = key_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/api/pgpkey/{keyID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/planning_data_load_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/planning_data_load_api.py new file mode 100644 index 0000000000..28f01b0cf5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/planning_data_load_api.py @@ -0,0 +1,740 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBytes, StrictStr +from typing import Optional, Tuple, Union +from typing_extensions import Annotated +from visier_platform_sdk.models.plan_data_upload_response_dto import PlanDataUploadResponseDTO +from visier_platform_sdk.models.plan_row_data_load_response_dto import PlanRowDataLoadResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class PlanningDataLoadApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def plan_data_load_plan_data_upload( + self, + plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")], + scenario_id: Annotated[StrictStr, Field(description="The unique identifier of the plan scenario to load data into.")], + calculation: Annotated[Optional[StrictStr], Field(description="Sets the plan values to rollup, distribute, or neither. Valid values: - **ROLLUP**: Roll up loaded data values to parent and ancestor rows. If the data provides a parent value and its child value, this method prioritizes the loaded value for the child and overwrites the parent. - **DISTRIBUTE**: Distribute loaded data values to their children and descendent rows. If the data provides a parent value and its child value, this method prioritizes the parent values and overrides the loaded child value. - **NONE**: The loaded values are not rolled up or distributed. This is the default.")] = None, + currency: Annotated[Optional[StrictStr], Field(description="The 3-digit ISO 4217 currency code of the data. If undefined, default is the plan's consolidation currency. If the currency is different from the plan's consolidation currency, the values are converted to the consolidation currency using the conversion rates loaded for the plan's baseline period.")] = None, + method: Annotated[Optional[StrictStr], Field(description="Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default.")] = None, + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The CSV file to load into the plan.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PlanDataUploadResponseDTO: + """Upload plan data + + Send a file to Visier to modify a plan's data. The file must be in CSV format and match the plan's schema. To get the plan's schema, call `GET /v1alpha/planning/model/plans/{id}?withSchema=true`. The data file must contain the following columns: - `periodId`: From the GET response, use the `date` values in the `timePeriods` array as values in this column. - A column for each `id` value in the `planSegmentLevels` object, where the row value is the `id` of the `members` in the `planSegmentLevelMembers` object. - A column for each `id` value in the `planItems` object that you want to modify data for, where the row value is the data value.
**Note:** 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). + + :param plan_id: The unique identifier of the plan. (required) + :type plan_id: str + :param scenario_id: The unique identifier of the plan scenario to load data into. (required) + :type scenario_id: str + :param calculation: Sets the plan values to rollup, distribute, or neither. Valid values: - **ROLLUP**: Roll up loaded data values to parent and ancestor rows. If the data provides a parent value and its child value, this method prioritizes the loaded value for the child and overwrites the parent. - **DISTRIBUTE**: Distribute loaded data values to their children and descendent rows. If the data provides a parent value and its child value, this method prioritizes the parent values and overrides the loaded child value. - **NONE**: The loaded values are not rolled up or distributed. This is the default. + :type calculation: str + :param currency: The 3-digit ISO 4217 currency code of the data. If undefined, default is the plan's consolidation currency. If the currency is different from the plan's consolidation currency, the values are converted to the consolidation currency using the conversion rates loaded for the plan's baseline period. + :type currency: str + :param method: Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default. + :type method: str + :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. + :type target_tenant_id: str + :param file: The CSV file to load into the plan. + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_data_load_plan_data_upload_serialize( + plan_id=plan_id, + scenario_id=scenario_id, + calculation=calculation, + currency=currency, + method=method, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanDataUploadResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def plan_data_load_plan_data_upload_with_http_info( + self, + plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")], + scenario_id: Annotated[StrictStr, Field(description="The unique identifier of the plan scenario to load data into.")], + calculation: Annotated[Optional[StrictStr], Field(description="Sets the plan values to rollup, distribute, or neither. Valid values: - **ROLLUP**: Roll up loaded data values to parent and ancestor rows. If the data provides a parent value and its child value, this method prioritizes the loaded value for the child and overwrites the parent. - **DISTRIBUTE**: Distribute loaded data values to their children and descendent rows. If the data provides a parent value and its child value, this method prioritizes the parent values and overrides the loaded child value. - **NONE**: The loaded values are not rolled up or distributed. This is the default.")] = None, + currency: Annotated[Optional[StrictStr], Field(description="The 3-digit ISO 4217 currency code of the data. If undefined, default is the plan's consolidation currency. If the currency is different from the plan's consolidation currency, the values are converted to the consolidation currency using the conversion rates loaded for the plan's baseline period.")] = None, + method: Annotated[Optional[StrictStr], Field(description="Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default.")] = None, + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The CSV file to load into the plan.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PlanDataUploadResponseDTO]: + """Upload plan data + + Send a file to Visier to modify a plan's data. The file must be in CSV format and match the plan's schema. To get the plan's schema, call `GET /v1alpha/planning/model/plans/{id}?withSchema=true`. The data file must contain the following columns: - `periodId`: From the GET response, use the `date` values in the `timePeriods` array as values in this column. - A column for each `id` value in the `planSegmentLevels` object, where the row value is the `id` of the `members` in the `planSegmentLevelMembers` object. - A column for each `id` value in the `planItems` object that you want to modify data for, where the row value is the data value.
**Note:** 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). + + :param plan_id: The unique identifier of the plan. (required) + :type plan_id: str + :param scenario_id: The unique identifier of the plan scenario to load data into. (required) + :type scenario_id: str + :param calculation: Sets the plan values to rollup, distribute, or neither. Valid values: - **ROLLUP**: Roll up loaded data values to parent and ancestor rows. If the data provides a parent value and its child value, this method prioritizes the loaded value for the child and overwrites the parent. - **DISTRIBUTE**: Distribute loaded data values to their children and descendent rows. If the data provides a parent value and its child value, this method prioritizes the parent values and overrides the loaded child value. - **NONE**: The loaded values are not rolled up or distributed. This is the default. + :type calculation: str + :param currency: The 3-digit ISO 4217 currency code of the data. If undefined, default is the plan's consolidation currency. If the currency is different from the plan's consolidation currency, the values are converted to the consolidation currency using the conversion rates loaded for the plan's baseline period. + :type currency: str + :param method: Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default. + :type method: str + :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. + :type target_tenant_id: str + :param file: The CSV file to load into the plan. + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_data_load_plan_data_upload_serialize( + plan_id=plan_id, + scenario_id=scenario_id, + calculation=calculation, + currency=currency, + method=method, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanDataUploadResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def plan_data_load_plan_data_upload_without_preload_content( + self, + plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")], + scenario_id: Annotated[StrictStr, Field(description="The unique identifier of the plan scenario to load data into.")], + calculation: Annotated[Optional[StrictStr], Field(description="Sets the plan values to rollup, distribute, or neither. Valid values: - **ROLLUP**: Roll up loaded data values to parent and ancestor rows. If the data provides a parent value and its child value, this method prioritizes the loaded value for the child and overwrites the parent. - **DISTRIBUTE**: Distribute loaded data values to their children and descendent rows. If the data provides a parent value and its child value, this method prioritizes the parent values and overrides the loaded child value. - **NONE**: The loaded values are not rolled up or distributed. This is the default.")] = None, + currency: Annotated[Optional[StrictStr], Field(description="The 3-digit ISO 4217 currency code of the data. If undefined, default is the plan's consolidation currency. If the currency is different from the plan's consolidation currency, the values are converted to the consolidation currency using the conversion rates loaded for the plan's baseline period.")] = None, + method: Annotated[Optional[StrictStr], Field(description="Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default.")] = None, + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The CSV file to load into the plan.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Upload plan data + + Send a file to Visier to modify a plan's data. The file must be in CSV format and match the plan's schema. To get the plan's schema, call `GET /v1alpha/planning/model/plans/{id}?withSchema=true`. The data file must contain the following columns: - `periodId`: From the GET response, use the `date` values in the `timePeriods` array as values in this column. - A column for each `id` value in the `planSegmentLevels` object, where the row value is the `id` of the `members` in the `planSegmentLevelMembers` object. - A column for each `id` value in the `planItems` object that you want to modify data for, where the row value is the data value.
**Note:** 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). + + :param plan_id: The unique identifier of the plan. (required) + :type plan_id: str + :param scenario_id: The unique identifier of the plan scenario to load data into. (required) + :type scenario_id: str + :param calculation: Sets the plan values to rollup, distribute, or neither. Valid values: - **ROLLUP**: Roll up loaded data values to parent and ancestor rows. If the data provides a parent value and its child value, this method prioritizes the loaded value for the child and overwrites the parent. - **DISTRIBUTE**: Distribute loaded data values to their children and descendent rows. If the data provides a parent value and its child value, this method prioritizes the parent values and overrides the loaded child value. - **NONE**: The loaded values are not rolled up or distributed. This is the default. + :type calculation: str + :param currency: The 3-digit ISO 4217 currency code of the data. If undefined, default is the plan's consolidation currency. If the currency is different from the plan's consolidation currency, the values are converted to the consolidation currency using the conversion rates loaded for the plan's baseline period. + :type currency: str + :param method: Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default. + :type method: str + :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. + :type target_tenant_id: str + :param file: The CSV file to load into the plan. + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_data_load_plan_data_upload_serialize( + plan_id=plan_id, + scenario_id=scenario_id, + calculation=calculation, + currency=currency, + method=method, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanDataUploadResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _plan_data_load_plan_data_upload_serialize( + self, + plan_id, + scenario_id, + calculation, + currency, + method, + target_tenant_id, + file, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if plan_id is not None: + _path_params['planId'] = plan_id + if scenario_id is not None: + _path_params['scenarioId'] = scenario_id + # process the query parameters + if calculation is not None: + + _query_params.append(('calculation', calculation)) + + if currency is not None: + + _query_params.append(('currency', currency)) + + if method is not None: + + _query_params.append(('method', method)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + if file is not None: + _files['file'] = file + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/v1alpha/planning/data/plans/{planId}/scenarios/{scenarioId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def plan_data_load_plan_row_data_load( + self, + plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")], + method: Annotated[Optional[StrictStr], Field(description="Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default.")] = None, + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The CSV file to load into the plan.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PlanRowDataLoadResponseDTO: + """Add or remove plan rows + + Send a file to Visier to modify a plan's rows. The file must be in CSV format and contain the following columns: - `Add/Remove`: In the column, use the value \"Add\" to add the specified row to the plan or \"Remove\" to remove the specified row from the plan. - A column for each plan segment level using the IDs from `planSegmentLevels`. - To add a row, use the corresponding segment member ID from `planSegmentLevelMembers`. If the member doesn't exist in the schema, provide a display name. The response returns its assigned segment member ID. - To remove a row, use the corresponding segmentId as the column name and the segment member ID from `planSegmentLevelMembers` as the row value.
**Note:** 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). + + :param plan_id: The unique identifier of the plan. (required) + :type plan_id: str + :param method: Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default. + :type method: str + :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. + :type target_tenant_id: str + :param file: The CSV file to load into the plan. + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_data_load_plan_row_data_load_serialize( + plan_id=plan_id, + method=method, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanRowDataLoadResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def plan_data_load_plan_row_data_load_with_http_info( + self, + plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")], + method: Annotated[Optional[StrictStr], Field(description="Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default.")] = None, + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The CSV file to load into the plan.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PlanRowDataLoadResponseDTO]: + """Add or remove plan rows + + Send a file to Visier to modify a plan's rows. The file must be in CSV format and contain the following columns: - `Add/Remove`: In the column, use the value \"Add\" to add the specified row to the plan or \"Remove\" to remove the specified row from the plan. - A column for each plan segment level using the IDs from `planSegmentLevels`. - To add a row, use the corresponding segment member ID from `planSegmentLevelMembers`. If the member doesn't exist in the schema, provide a display name. The response returns its assigned segment member ID. - To remove a row, use the corresponding segmentId as the column name and the segment member ID from `planSegmentLevelMembers` as the row value.
**Note:** 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). + + :param plan_id: The unique identifier of the plan. (required) + :type plan_id: str + :param method: Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default. + :type method: str + :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. + :type target_tenant_id: str + :param file: The CSV file to load into the plan. + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_data_load_plan_row_data_load_serialize( + plan_id=plan_id, + method=method, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanRowDataLoadResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def plan_data_load_plan_row_data_load_without_preload_content( + self, + plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")], + method: Annotated[Optional[StrictStr], Field(description="Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default.")] = None, + 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, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The CSV file to load into the plan.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add or remove plan rows + + Send a file to Visier to modify a plan's rows. The file must be in CSV format and contain the following columns: - `Add/Remove`: In the column, use the value \"Add\" to add the specified row to the plan or \"Remove\" to remove the specified row from the plan. - A column for each plan segment level using the IDs from `planSegmentLevels`. - To add a row, use the corresponding segment member ID from `planSegmentLevelMembers`. If the member doesn't exist in the schema, provide a display name. The response returns its assigned segment member ID. - To remove a row, use the corresponding segmentId as the column name and the segment member ID from `planSegmentLevelMembers` as the row value.
**Note:** 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). + + :param plan_id: The unique identifier of the plan. (required) + :type plan_id: str + :param method: Sets how to validate the data being loaded into Visier. Valid values: - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data. - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan. - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default. + :type method: str + :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. + :type target_tenant_id: str + :param file: The CSV file to load into the plan. + :type file: bytearray + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._plan_data_load_plan_row_data_load_serialize( + plan_id=plan_id, + method=method, + target_tenant_id=target_tenant_id, + file=file, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PlanRowDataLoadResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _plan_data_load_plan_row_data_load_serialize( + self, + plan_id, + method, + target_tenant_id, + file, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if plan_id is not None: + _path_params['planId'] = plan_id + # process the query parameters + if method is not None: + + _query_params.append(('method', method)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + if file is not None: + _files['file'] = file + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'multipart/form-data' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/v1alpha/planning/data/plans/{planId}/rows', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/production_versions_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/production_versions_api.py new file mode 100644 index 0000000000..a49a670e2b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/production_versions_api.py @@ -0,0 +1,944 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.servicing_get_production_versions_api_response_dto import ServicingGetProductionVersionsAPIResponseDTO +from visier_platform_sdk.models.servicing_production_version_api_operation_request_dto import ServicingProductionVersionAPIOperationRequestDTO +from visier_platform_sdk.models.servicing_production_version_api_operation_response_dto import ServicingProductionVersionAPIOperationResponseDTO +from visier_platform_sdk.models.servicing_production_versions_api_operation_request_dto import ServicingProductionVersionsAPIOperationRequestDTO +from visier_platform_sdk.models.servicing_production_versions_api_operation_response_dto import ServicingProductionVersionsAPIOperationResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class ProductionVersionsApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def get_production_versions( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of production versions to return. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first production version to return. Default is 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingGetProductionVersionsAPIResponseDTO: + """Retrieve a list of all production versions + + Retrieve a list of all projects that were published to production, ordered from latest published to earliest published. + + :param limit: The maximum number of production versions to return. Default is 400. + :type limit: int + :param start: The starting index of the first production version to return. Default is 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_production_versions_serialize( + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetProductionVersionsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_production_versions_with_http_info( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of production versions to return. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first production version to return. Default is 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingGetProductionVersionsAPIResponseDTO]: + """Retrieve a list of all production versions + + Retrieve a list of all projects that were published to production, ordered from latest published to earliest published. + + :param limit: The maximum number of production versions to return. Default is 400. + :type limit: int + :param start: The starting index of the first production version to return. Default is 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_production_versions_serialize( + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetProductionVersionsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_production_versions_without_preload_content( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of production versions to return. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first production version to return. Default is 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all production versions + + Retrieve a list of all projects that were published to production, ordered from latest published to earliest published. + + :param limit: The maximum number of production versions to return. Default is 400. + :type limit: int + :param start: The starting index of the first production version to return. Default is 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_production_versions_serialize( + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetProductionVersionsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_production_versions_serialize( + self, + limit, + start, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/production-versions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def post_production_version( + self, + production_version_id: Annotated[StrictStr, Field(description="The production version to use as the target of the operation; for example, the production version to roll back to for the `rollBackTo` operation.")], + servicing_production_version_api_operation_request_dto: ServicingProductionVersionAPIOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProductionVersionAPIOperationResponseDTO: + """Perform an operation on a production version + + Perform operations on a specific production version. The following operations are supported: * `rollBackTo`: Create a project that rolls back the production version to the specified version. The project contains uncommitted changes that reverse the published versions after the target production version. + + :param production_version_id: The production version to use as the target of the operation; for example, the production version to roll back to for the `rollBackTo` operation. (required) + :type production_version_id: str + :param servicing_production_version_api_operation_request_dto: (required) + :type servicing_production_version_api_operation_request_dto: ServicingProductionVersionAPIOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._post_production_version_serialize( + production_version_id=production_version_id, + servicing_production_version_api_operation_request_dto=servicing_production_version_api_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProductionVersionAPIOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def post_production_version_with_http_info( + self, + production_version_id: Annotated[StrictStr, Field(description="The production version to use as the target of the operation; for example, the production version to roll back to for the `rollBackTo` operation.")], + servicing_production_version_api_operation_request_dto: ServicingProductionVersionAPIOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProductionVersionAPIOperationResponseDTO]: + """Perform an operation on a production version + + Perform operations on a specific production version. The following operations are supported: * `rollBackTo`: Create a project that rolls back the production version to the specified version. The project contains uncommitted changes that reverse the published versions after the target production version. + + :param production_version_id: The production version to use as the target of the operation; for example, the production version to roll back to for the `rollBackTo` operation. (required) + :type production_version_id: str + :param servicing_production_version_api_operation_request_dto: (required) + :type servicing_production_version_api_operation_request_dto: ServicingProductionVersionAPIOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._post_production_version_serialize( + production_version_id=production_version_id, + servicing_production_version_api_operation_request_dto=servicing_production_version_api_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProductionVersionAPIOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def post_production_version_without_preload_content( + self, + production_version_id: Annotated[StrictStr, Field(description="The production version to use as the target of the operation; for example, the production version to roll back to for the `rollBackTo` operation.")], + servicing_production_version_api_operation_request_dto: ServicingProductionVersionAPIOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Perform an operation on a production version + + Perform operations on a specific production version. The following operations are supported: * `rollBackTo`: Create a project that rolls back the production version to the specified version. The project contains uncommitted changes that reverse the published versions after the target production version. + + :param production_version_id: The production version to use as the target of the operation; for example, the production version to roll back to for the `rollBackTo` operation. (required) + :type production_version_id: str + :param servicing_production_version_api_operation_request_dto: (required) + :type servicing_production_version_api_operation_request_dto: ServicingProductionVersionAPIOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._post_production_version_serialize( + production_version_id=production_version_id, + servicing_production_version_api_operation_request_dto=servicing_production_version_api_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProductionVersionAPIOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _post_production_version_serialize( + self, + production_version_id, + servicing_production_version_api_operation_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if production_version_id is not None: + _path_params['productionVersionId'] = production_version_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_production_version_api_operation_request_dto is not None: + _body_params = servicing_production_version_api_operation_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/production-versions/{productionVersionId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def post_production_versions( + self, + servicing_production_versions_api_operation_request_dto: ServicingProductionVersionsAPIOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProductionVersionsAPIOperationResponseDTO: + """Perform an operation on production versions + + Perform operations on production versions, such as exporting a production project's committed changes. If exporting, please specify `Accept: application/zip, application/json` in the header. The API returns exported changes in ZIP format and error messages in JSON format. If your request returns an error and it doesn't accept `application/json`, you will receive an HTTP 406 status code instead of the appropriate error response body. + + :param servicing_production_versions_api_operation_request_dto: (required) + :type servicing_production_versions_api_operation_request_dto: ServicingProductionVersionsAPIOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._post_production_versions_serialize( + servicing_production_versions_api_operation_request_dto=servicing_production_versions_api_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProductionVersionsAPIOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def post_production_versions_with_http_info( + self, + servicing_production_versions_api_operation_request_dto: ServicingProductionVersionsAPIOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProductionVersionsAPIOperationResponseDTO]: + """Perform an operation on production versions + + Perform operations on production versions, such as exporting a production project's committed changes. If exporting, please specify `Accept: application/zip, application/json` in the header. The API returns exported changes in ZIP format and error messages in JSON format. If your request returns an error and it doesn't accept `application/json`, you will receive an HTTP 406 status code instead of the appropriate error response body. + + :param servicing_production_versions_api_operation_request_dto: (required) + :type servicing_production_versions_api_operation_request_dto: ServicingProductionVersionsAPIOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._post_production_versions_serialize( + servicing_production_versions_api_operation_request_dto=servicing_production_versions_api_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProductionVersionsAPIOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def post_production_versions_without_preload_content( + self, + servicing_production_versions_api_operation_request_dto: ServicingProductionVersionsAPIOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Perform an operation on production versions + + Perform operations on production versions, such as exporting a production project's committed changes. If exporting, please specify `Accept: application/zip, application/json` in the header. The API returns exported changes in ZIP format and error messages in JSON format. If your request returns an error and it doesn't accept `application/json`, you will receive an HTTP 406 status code instead of the appropriate error response body. + + :param servicing_production_versions_api_operation_request_dto: (required) + :type servicing_production_versions_api_operation_request_dto: ServicingProductionVersionsAPIOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._post_production_versions_serialize( + servicing_production_versions_api_operation_request_dto=servicing_production_versions_api_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProductionVersionsAPIOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _post_production_versions_serialize( + self, + servicing_production_versions_api_operation_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_production_versions_api_operation_request_dto is not None: + _body_params = servicing_production_versions_api_operation_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/production-versions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/profiles_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/profiles_api.py new file mode 100644 index 0000000000..541c4b83e5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/profiles_api.py @@ -0,0 +1,2873 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.servicing_accessible_tenant_profile_assignment_request_dto import ServicingAccessibleTenantProfileAssignmentRequestDTO +from visier_platform_sdk.models.servicing_accessible_tenant_profile_assignment_response_dto import ServicingAccessibleTenantProfileAssignmentResponseDTO +from visier_platform_sdk.models.servicing_accessible_tenant_profile_revoke_request_dto import ServicingAccessibleTenantProfileRevokeRequestDTO +from visier_platform_sdk.models.servicing_accessible_tenant_profile_revoke_response_dto import ServicingAccessibleTenantProfileRevokeResponseDTO +from visier_platform_sdk.models.servicing_all_profile_assigned_for_accessible_tenant_dto import ServicingAllProfileAssignedForAccessibleTenantDTO +from visier_platform_sdk.models.servicing_all_profile_assigned_for_local_tenant_dto import ServicingAllProfileAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_assignment_request_dto import ServicingLocalTenantProfileAssignmentRequestDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_assignment_response_dto import ServicingLocalTenantProfileAssignmentResponseDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_revoke_request_dto import ServicingLocalTenantProfileRevokeRequestDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_revoke_response_dto import ServicingLocalTenantProfileRevokeResponseDTO +from visier_platform_sdk.models.servicing_profile_get_api_response_dto import ServicingProfileGetAPIResponseDTO +from visier_platform_sdk.models.servicing_profiles_get_api_response_dto import ServicingProfilesGetAPIResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class ProfilesApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def assign_analytic_profile( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to assign.")], + servicing_accessible_tenant_profile_assignment_request_dto: ServicingAccessibleTenantProfileAssignmentRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingAccessibleTenantProfileAssignmentResponseDTO: + """Assign an analytic tenant profile to administrating tenant users + + Assign an analytic tenant profile to a list of administrating tenant users for a list of analytic tenants. **Note:** - Administrating tenants only. - You can revoke a profile from a user with this request by updating the validityEndTime to be \"less than\" the current time (that is, in the past). + + :param profile_id: The ID of the profile to assign. (required) + :type profile_id: str + :param servicing_accessible_tenant_profile_assignment_request_dto: (required) + :type servicing_accessible_tenant_profile_assignment_request_dto: ServicingAccessibleTenantProfileAssignmentRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_analytic_profile_serialize( + profile_id=profile_id, + servicing_accessible_tenant_profile_assignment_request_dto=servicing_accessible_tenant_profile_assignment_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAccessibleTenantProfileAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def assign_analytic_profile_with_http_info( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to assign.")], + servicing_accessible_tenant_profile_assignment_request_dto: ServicingAccessibleTenantProfileAssignmentRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingAccessibleTenantProfileAssignmentResponseDTO]: + """Assign an analytic tenant profile to administrating tenant users + + Assign an analytic tenant profile to a list of administrating tenant users for a list of analytic tenants. **Note:** - Administrating tenants only. - You can revoke a profile from a user with this request by updating the validityEndTime to be \"less than\" the current time (that is, in the past). + + :param profile_id: The ID of the profile to assign. (required) + :type profile_id: str + :param servicing_accessible_tenant_profile_assignment_request_dto: (required) + :type servicing_accessible_tenant_profile_assignment_request_dto: ServicingAccessibleTenantProfileAssignmentRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_analytic_profile_serialize( + profile_id=profile_id, + servicing_accessible_tenant_profile_assignment_request_dto=servicing_accessible_tenant_profile_assignment_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAccessibleTenantProfileAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def assign_analytic_profile_without_preload_content( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to assign.")], + servicing_accessible_tenant_profile_assignment_request_dto: ServicingAccessibleTenantProfileAssignmentRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Assign an analytic tenant profile to administrating tenant users + + Assign an analytic tenant profile to a list of administrating tenant users for a list of analytic tenants. **Note:** - Administrating tenants only. - You can revoke a profile from a user with this request by updating the validityEndTime to be \"less than\" the current time (that is, in the past). + + :param profile_id: The ID of the profile to assign. (required) + :type profile_id: str + :param servicing_accessible_tenant_profile_assignment_request_dto: (required) + :type servicing_accessible_tenant_profile_assignment_request_dto: ServicingAccessibleTenantProfileAssignmentRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_analytic_profile_serialize( + profile_id=profile_id, + servicing_accessible_tenant_profile_assignment_request_dto=servicing_accessible_tenant_profile_assignment_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAccessibleTenantProfileAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _assign_analytic_profile_serialize( + self, + profile_id, + servicing_accessible_tenant_profile_assignment_request_dto, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if profile_id is not None: + _path_params['profileId'] = profile_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if servicing_accessible_tenant_profile_assignment_request_dto is not None: + _body_params = servicing_accessible_tenant_profile_assignment_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/profiles/accessible-tenants/{profileId}/assign', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def assign_profile( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to assign to a list of users.")], + servicing_local_tenant_profile_assignment_request_dto: ServicingLocalTenantProfileAssignmentRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingLocalTenantProfileAssignmentResponseDTO: + """Assign a profile to a list of users + + Assign a profile to a list of users. For administrating tenants, this assigns an administrating tenant profile to a list of users. + + :param profile_id: The ID of the profile to assign to a list of users. (required) + :type profile_id: str + :param servicing_local_tenant_profile_assignment_request_dto: (required) + :type servicing_local_tenant_profile_assignment_request_dto: ServicingLocalTenantProfileAssignmentRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_profile_serialize( + profile_id=profile_id, + servicing_local_tenant_profile_assignment_request_dto=servicing_local_tenant_profile_assignment_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingLocalTenantProfileAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def assign_profile_with_http_info( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to assign to a list of users.")], + servicing_local_tenant_profile_assignment_request_dto: ServicingLocalTenantProfileAssignmentRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingLocalTenantProfileAssignmentResponseDTO]: + """Assign a profile to a list of users + + Assign a profile to a list of users. For administrating tenants, this assigns an administrating tenant profile to a list of users. + + :param profile_id: The ID of the profile to assign to a list of users. (required) + :type profile_id: str + :param servicing_local_tenant_profile_assignment_request_dto: (required) + :type servicing_local_tenant_profile_assignment_request_dto: ServicingLocalTenantProfileAssignmentRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_profile_serialize( + profile_id=profile_id, + servicing_local_tenant_profile_assignment_request_dto=servicing_local_tenant_profile_assignment_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingLocalTenantProfileAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def assign_profile_without_preload_content( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to assign to a list of users.")], + servicing_local_tenant_profile_assignment_request_dto: ServicingLocalTenantProfileAssignmentRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Assign a profile to a list of users + + Assign a profile to a list of users. For administrating tenants, this assigns an administrating tenant profile to a list of users. + + :param profile_id: The ID of the profile to assign to a list of users. (required) + :type profile_id: str + :param servicing_local_tenant_profile_assignment_request_dto: (required) + :type servicing_local_tenant_profile_assignment_request_dto: ServicingLocalTenantProfileAssignmentRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_profile_serialize( + profile_id=profile_id, + servicing_local_tenant_profile_assignment_request_dto=servicing_local_tenant_profile_assignment_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingLocalTenantProfileAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _assign_profile_serialize( + self, + profile_id, + servicing_local_tenant_profile_assignment_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if profile_id is not None: + _path_params['profileId'] = profile_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_local_tenant_profile_assignment_request_dto is not None: + _body_params = servicing_local_tenant_profile_assignment_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/profiles/{profileId}/assign', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_profiles( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProfilesGetAPIResponseDTO: + """Retrieve a list of all profiles + + Get a list of all available profiles. For administrating tenants, this retrieves all administrating tenant profiles. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_profiles_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfilesGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_profiles_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProfilesGetAPIResponseDTO]: + """Retrieve a list of all profiles + + Get a list of all available profiles. For administrating tenants, this retrieves all administrating tenant profiles. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_profiles_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfilesGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_profiles_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all profiles + + Get a list of all available profiles. For administrating tenants, this retrieves all administrating tenant profiles. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_profiles_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfilesGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_profiles_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/profiles', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_analytic_profile_detail( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to retrieve details for.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProfileGetAPIResponseDTO: + """Retrieve the details of an analytic tenant profile + + Get the details of an analytic tenant profile. **Note:** Administrating tenants only. + + :param profile_id: The ID of the profile to retrieve details for. (required) + :type profile_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_profile_detail_serialize( + profile_id=profile_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfileGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_analytic_profile_detail_with_http_info( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to retrieve details for.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProfileGetAPIResponseDTO]: + """Retrieve the details of an analytic tenant profile + + Get the details of an analytic tenant profile. **Note:** Administrating tenants only. + + :param profile_id: The ID of the profile to retrieve details for. (required) + :type profile_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_profile_detail_serialize( + profile_id=profile_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfileGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_analytic_profile_detail_without_preload_content( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to retrieve details for.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the details of an analytic tenant profile + + Get the details of an analytic tenant profile. **Note:** Administrating tenants only. + + :param profile_id: The ID of the profile to retrieve details for. (required) + :type profile_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_profile_detail_serialize( + profile_id=profile_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfileGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_analytic_profile_detail_serialize( + self, + profile_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if profile_id is not None: + _path_params['profileId'] = profile_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/profiles/accessible-tenants/{profileId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_analytic_profiles( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProfilesGetAPIResponseDTO: + """Retrieve a list of analytic tenant profiles + + Retrieve a list of profiles available for analytic tenants. **Note:** Administrating tenants only. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_profiles_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfilesGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_analytic_profiles_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProfilesGetAPIResponseDTO]: + """Retrieve a list of analytic tenant profiles + + Retrieve a list of profiles available for analytic tenants. **Note:** Administrating tenants only. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_profiles_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfilesGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_analytic_profiles_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of analytic tenant profiles + + Retrieve a list of profiles available for analytic tenants. **Note:** Administrating tenants only. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_profiles_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfilesGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_analytic_profiles_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/profiles/accessible-tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_analytic_user_profile( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to retrieve.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingAllProfileAssignedForAccessibleTenantDTO: + """Retrieve an administrating tenant user's analytic tenant profiles + + Retrieve a specified user's assigned profiles for analytic tenants. **Note:** Administrating tenants only. + + :param user_id: The ID of the user you want to retrieve. (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_user_profile_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAllProfileAssignedForAccessibleTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_analytic_user_profile_with_http_info( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to retrieve.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingAllProfileAssignedForAccessibleTenantDTO]: + """Retrieve an administrating tenant user's analytic tenant profiles + + Retrieve a specified user's assigned profiles for analytic tenants. **Note:** Administrating tenants only. + + :param user_id: The ID of the user you want to retrieve. (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_user_profile_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAllProfileAssignedForAccessibleTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_analytic_user_profile_without_preload_content( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to retrieve.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an administrating tenant user's analytic tenant profiles + + Retrieve a specified user's assigned profiles for analytic tenants. **Note:** Administrating tenants only. + + :param user_id: The ID of the user you want to retrieve. (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_analytic_user_profile_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAllProfileAssignedForAccessibleTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_analytic_user_profile_serialize( + self, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/users/{userId}/accessible-tenant-profiles', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_profile_detail( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to retrieve details for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProfileGetAPIResponseDTO: + """Retrieve the details of a profile + + Get the details of a specific profile. For administrating tenants, this retrieves the details of administrating tenant profiles. + + :param profile_id: The ID of the profile to retrieve details for. (required) + :type profile_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_profile_detail_serialize( + profile_id=profile_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfileGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_profile_detail_with_http_info( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to retrieve details for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProfileGetAPIResponseDTO]: + """Retrieve the details of a profile + + Get the details of a specific profile. For administrating tenants, this retrieves the details of administrating tenant profiles. + + :param profile_id: The ID of the profile to retrieve details for. (required) + :type profile_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_profile_detail_serialize( + profile_id=profile_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfileGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_profile_detail_without_preload_content( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to retrieve details for.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the details of a profile + + Get the details of a specific profile. For administrating tenants, this retrieves the details of administrating tenant profiles. + + :param profile_id: The ID of the profile to retrieve details for. (required) + :type profile_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_profile_detail_serialize( + profile_id=profile_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProfileGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_profile_detail_serialize( + self, + profile_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if profile_id is not None: + _path_params['profileId'] = profile_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/profiles/{profileId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_user_profile( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingAllProfileAssignedForLocalTenantDTO: + """Retrieve a user's profiles + + Retrieve a specified user's assigned profiles. For administrating tenants, this retrieves a user's administrating tenant profiles. + + :param user_id: The ID of the user you want to retrieve. (required) + :type user_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_profile_serialize( + user_id=user_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAllProfileAssignedForLocalTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_profile_with_http_info( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingAllProfileAssignedForLocalTenantDTO]: + """Retrieve a user's profiles + + Retrieve a specified user's assigned profiles. For administrating tenants, this retrieves a user's administrating tenant profiles. + + :param user_id: The ID of the user you want to retrieve. (required) + :type user_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_profile_serialize( + user_id=user_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAllProfileAssignedForLocalTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_profile_without_preload_content( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a user's profiles + + Retrieve a specified user's assigned profiles. For administrating tenants, this retrieves a user's administrating tenant profiles. + + :param user_id: The ID of the user you want to retrieve. (required) + :type user_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_profile_serialize( + user_id=user_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAllProfileAssignedForLocalTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_profile_serialize( + self, + user_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/users/{userId}/profiles', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def remove_analytic_profile( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to remove.")], + servicing_accessible_tenant_profile_revoke_request_dto: ServicingAccessibleTenantProfileRevokeRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingAccessibleTenantProfileRevokeResponseDTO: + """Remove an analytic tenant profile from administrating tenant users + + Remove an analytic tenant profile from a list of administrating tenant users for a list of analytic tenants. **Note:** Administrating tenants only. + + :param profile_id: The ID of the profile to remove. (required) + :type profile_id: str + :param servicing_accessible_tenant_profile_revoke_request_dto: (required) + :type servicing_accessible_tenant_profile_revoke_request_dto: ServicingAccessibleTenantProfileRevokeRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_analytic_profile_serialize( + profile_id=profile_id, + servicing_accessible_tenant_profile_revoke_request_dto=servicing_accessible_tenant_profile_revoke_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAccessibleTenantProfileRevokeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def remove_analytic_profile_with_http_info( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to remove.")], + servicing_accessible_tenant_profile_revoke_request_dto: ServicingAccessibleTenantProfileRevokeRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingAccessibleTenantProfileRevokeResponseDTO]: + """Remove an analytic tenant profile from administrating tenant users + + Remove an analytic tenant profile from a list of administrating tenant users for a list of analytic tenants. **Note:** Administrating tenants only. + + :param profile_id: The ID of the profile to remove. (required) + :type profile_id: str + :param servicing_accessible_tenant_profile_revoke_request_dto: (required) + :type servicing_accessible_tenant_profile_revoke_request_dto: ServicingAccessibleTenantProfileRevokeRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_analytic_profile_serialize( + profile_id=profile_id, + servicing_accessible_tenant_profile_revoke_request_dto=servicing_accessible_tenant_profile_revoke_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAccessibleTenantProfileRevokeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def remove_analytic_profile_without_preload_content( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to remove.")], + servicing_accessible_tenant_profile_revoke_request_dto: ServicingAccessibleTenantProfileRevokeRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Remove an analytic tenant profile from administrating tenant users + + Remove an analytic tenant profile from a list of administrating tenant users for a list of analytic tenants. **Note:** Administrating tenants only. + + :param profile_id: The ID of the profile to remove. (required) + :type profile_id: str + :param servicing_accessible_tenant_profile_revoke_request_dto: (required) + :type servicing_accessible_tenant_profile_revoke_request_dto: ServicingAccessibleTenantProfileRevokeRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_analytic_profile_serialize( + profile_id=profile_id, + servicing_accessible_tenant_profile_revoke_request_dto=servicing_accessible_tenant_profile_revoke_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAccessibleTenantProfileRevokeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _remove_analytic_profile_serialize( + self, + profile_id, + servicing_accessible_tenant_profile_revoke_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if profile_id is not None: + _path_params['profileId'] = profile_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_accessible_tenant_profile_revoke_request_dto is not None: + _body_params = servicing_accessible_tenant_profile_revoke_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/admin/profiles/accessible-tenants/{profileId}/remove', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def remove_profile( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to remove to a list of users.")], + servicing_local_tenant_profile_revoke_request_dto: ServicingLocalTenantProfileRevokeRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingLocalTenantProfileRevokeResponseDTO: + """Remove a profile from a list of users + + Remove a profile from a list of users. For administrating tenants, this removes an administrating tenant profile from a list of users. + + :param profile_id: The ID of the profile to remove to a list of users. (required) + :type profile_id: str + :param servicing_local_tenant_profile_revoke_request_dto: (required) + :type servicing_local_tenant_profile_revoke_request_dto: ServicingLocalTenantProfileRevokeRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_profile_serialize( + profile_id=profile_id, + servicing_local_tenant_profile_revoke_request_dto=servicing_local_tenant_profile_revoke_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingLocalTenantProfileRevokeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def remove_profile_with_http_info( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to remove to a list of users.")], + servicing_local_tenant_profile_revoke_request_dto: ServicingLocalTenantProfileRevokeRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingLocalTenantProfileRevokeResponseDTO]: + """Remove a profile from a list of users + + Remove a profile from a list of users. For administrating tenants, this removes an administrating tenant profile from a list of users. + + :param profile_id: The ID of the profile to remove to a list of users. (required) + :type profile_id: str + :param servicing_local_tenant_profile_revoke_request_dto: (required) + :type servicing_local_tenant_profile_revoke_request_dto: ServicingLocalTenantProfileRevokeRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_profile_serialize( + profile_id=profile_id, + servicing_local_tenant_profile_revoke_request_dto=servicing_local_tenant_profile_revoke_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingLocalTenantProfileRevokeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def remove_profile_without_preload_content( + self, + profile_id: Annotated[StrictStr, Field(description="The ID of the profile to remove to a list of users.")], + servicing_local_tenant_profile_revoke_request_dto: ServicingLocalTenantProfileRevokeRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Remove a profile from a list of users + + Remove a profile from a list of users. For administrating tenants, this removes an administrating tenant profile from a list of users. + + :param profile_id: The ID of the profile to remove to a list of users. (required) + :type profile_id: str + :param servicing_local_tenant_profile_revoke_request_dto: (required) + :type servicing_local_tenant_profile_revoke_request_dto: ServicingLocalTenantProfileRevokeRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_profile_serialize( + profile_id=profile_id, + servicing_local_tenant_profile_revoke_request_dto=servicing_local_tenant_profile_revoke_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingLocalTenantProfileRevokeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _remove_profile_serialize( + self, + profile_id, + servicing_local_tenant_profile_revoke_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if profile_id is not None: + _path_params['profileId'] = profile_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_local_tenant_profile_revoke_request_dto is not None: + _body_params = servicing_local_tenant_profile_revoke_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/admin/profiles/{profileId}/remove', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/projects_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/projects_api.py new file mode 100644 index 0000000000..f179fab505 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/projects_api.py @@ -0,0 +1,2128 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr +from typing import List, Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_put_project_commits_request import AdminPutProjectCommitsRequest +from visier_platform_sdk.models.servicing_get_projects_api_response_dto import ServicingGetProjectsAPIResponseDTO +from visier_platform_sdk.models.servicing_project_commits_api_response_dto import ServicingProjectCommitsAPIResponseDTO +from visier_platform_sdk.models.servicing_project_dto import ServicingProjectDTO +from visier_platform_sdk.models.servicing_project_operation_request_dto import ServicingProjectOperationRequestDTO +from visier_platform_sdk.models.servicing_project_operation_response_dto import ServicingProjectOperationResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class ProjectsApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def create_project( + self, + servicing_project_dto: ServicingProjectDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProjectDTO: + """Create a new draft project + + Create a new draft project in the tenant. + + :param servicing_project_dto: (required) + :type servicing_project_dto: ServicingProjectDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_project_serialize( + servicing_project_dto=servicing_project_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_project_with_http_info( + self, + servicing_project_dto: ServicingProjectDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProjectDTO]: + """Create a new draft project + + Create a new draft project in the tenant. + + :param servicing_project_dto: (required) + :type servicing_project_dto: ServicingProjectDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_project_serialize( + servicing_project_dto=servicing_project_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_project_without_preload_content( + self, + servicing_project_dto: ServicingProjectDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new draft project + + Create a new draft project in the tenant. + + :param servicing_project_dto: (required) + :type servicing_project_dto: ServicingProjectDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_project_serialize( + servicing_project_dto=servicing_project_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_project_serialize( + self, + servicing_project_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_project_dto is not None: + _body_params = servicing_project_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/projects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_project( + self, + project_id: Annotated[StrictStr, Field(description="The unique ID of the draft project to be deleted.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProjectDTO: + """Delete a draft project + + Delete a draft project in the tenant. The project will first be archived if applicable. + + :param project_id: The unique ID of the draft project to be deleted. (required) + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_project_serialize( + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_project_with_http_info( + self, + project_id: Annotated[StrictStr, Field(description="The unique ID of the draft project to be deleted.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProjectDTO]: + """Delete a draft project + + Delete a draft project in the tenant. The project will first be archived if applicable. + + :param project_id: The unique ID of the draft project to be deleted. (required) + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_project_serialize( + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_project_without_preload_content( + self, + project_id: Annotated[StrictStr, Field(description="The unique ID of the draft project to be deleted.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a draft project + + Delete a draft project in the tenant. The project will first be archived if applicable. + + :param project_id: The unique ID of the draft project to be deleted. (required) + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_project_serialize( + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_project_serialize( + self, + project_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if project_id is not None: + _path_params['projectId'] = project_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/admin/projects/{projectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_project( + self, + project_id: Annotated[StrictStr, Field(description="The unique identifier of the draft project you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProjectDTO: + """Retrieve a draft project's information + + Retrieve the details of an accessible draft project. You must know the ID of the project to retrieve its details. To retrieve draft project IDs, see `GET /v1/admin/projects`. A project is accessible if it is owned by the user or shared to the user. + + :param project_id: The unique identifier of the draft project you want to retrieve. (required) + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_project_serialize( + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_project_with_http_info( + self, + project_id: Annotated[StrictStr, Field(description="The unique identifier of the draft project you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProjectDTO]: + """Retrieve a draft project's information + + Retrieve the details of an accessible draft project. You must know the ID of the project to retrieve its details. To retrieve draft project IDs, see `GET /v1/admin/projects`. A project is accessible if it is owned by the user or shared to the user. + + :param project_id: The unique identifier of the draft project you want to retrieve. (required) + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_project_serialize( + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_project_without_preload_content( + self, + project_id: Annotated[StrictStr, Field(description="The unique identifier of the draft project you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a draft project's information + + Retrieve the details of an accessible draft project. You must know the ID of the project to retrieve its details. To retrieve draft project IDs, see `GET /v1/admin/projects`. A project is accessible if it is owned by the user or shared to the user. + + :param project_id: The unique identifier of the draft project you want to retrieve. (required) + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_project_serialize( + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_project_serialize( + self, + project_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if project_id is not None: + _path_params['projectId'] = project_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/projects/{projectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_project_commits( + self, + project_id: Annotated[StrictStr, Field(description="The unique identifier of the draft project you want to retrieve the committed changes for.")], + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of committed changes to return. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first committed change to return. Default is 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProjectCommitsAPIResponseDTO: + """Retrieve a list of all committed changes in a project + + Retrieve the full list of all committed changes in a project. + + :param project_id: The unique identifier of the draft project you want to retrieve the committed changes for. (required) + :type project_id: str + :param limit: The maximum number of committed changes to return. Default is 400. + :type limit: int + :param start: The starting index of the first committed change to return. Default is 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_project_commits_serialize( + project_id=project_id, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectCommitsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_project_commits_with_http_info( + self, + project_id: Annotated[StrictStr, Field(description="The unique identifier of the draft project you want to retrieve the committed changes for.")], + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of committed changes to return. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first committed change to return. Default is 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProjectCommitsAPIResponseDTO]: + """Retrieve a list of all committed changes in a project + + Retrieve the full list of all committed changes in a project. + + :param project_id: The unique identifier of the draft project you want to retrieve the committed changes for. (required) + :type project_id: str + :param limit: The maximum number of committed changes to return. Default is 400. + :type limit: int + :param start: The starting index of the first committed change to return. Default is 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_project_commits_serialize( + project_id=project_id, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectCommitsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_project_commits_without_preload_content( + self, + project_id: Annotated[StrictStr, Field(description="The unique identifier of the draft project you want to retrieve the committed changes for.")], + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of committed changes to return. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first committed change to return. Default is 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all committed changes in a project + + Retrieve the full list of all committed changes in a project. + + :param project_id: The unique identifier of the draft project you want to retrieve the committed changes for. (required) + :type project_id: str + :param limit: The maximum number of committed changes to return. Default is 400. + :type limit: int + :param start: The starting index of the first committed change to return. Default is 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_project_commits_serialize( + project_id=project_id, + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectCommitsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_project_commits_serialize( + self, + project_id, + limit, + start, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if project_id is not None: + _path_params['projectId'] = project_id + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/projects/{projectId}/commits', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_projects( + self, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The types of draft projects to include in the request response. * If empty, returns all the `Open` draft projects. * If `Open`, returns all Open draft projects. * If `Approval`, returns all draft projects in the approval stage. Changes cannot made in Approval projects. * If `Rejected`, returns all draft projects that have been rejected. Changes cannot be committed in Rejected projects. * If `Archived`, returns all draft projects that have been archived. Changes cannot be committed in Archived projects.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of projects to return per type. The maximum number of projects to retrieve per type is 1000. The default is 100.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingGetProjectsAPIResponseDTO: + """Retrieve a list of draft projects accessible to the user + + Get a list of draft projects accessible to the requesting user in the tenant. A project is accessible if it is owned by the user or shared to the user. + + :param var_with: The types of draft projects to include in the request response. * If empty, returns all the `Open` draft projects. * If `Open`, returns all Open draft projects. * If `Approval`, returns all draft projects in the approval stage. Changes cannot made in Approval projects. * If `Rejected`, returns all draft projects that have been rejected. Changes cannot be committed in Rejected projects. * If `Archived`, returns all draft projects that have been archived. Changes cannot be committed in Archived projects. + :type var_with: List[str] + :param limit: The number of projects to return per type. The maximum number of projects to retrieve per type is 1000. The default is 100. + :type limit: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_projects_serialize( + var_with=var_with, + limit=limit, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetProjectsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_projects_with_http_info( + self, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The types of draft projects to include in the request response. * If empty, returns all the `Open` draft projects. * If `Open`, returns all Open draft projects. * If `Approval`, returns all draft projects in the approval stage. Changes cannot made in Approval projects. * If `Rejected`, returns all draft projects that have been rejected. Changes cannot be committed in Rejected projects. * If `Archived`, returns all draft projects that have been archived. Changes cannot be committed in Archived projects.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of projects to return per type. The maximum number of projects to retrieve per type is 1000. The default is 100.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingGetProjectsAPIResponseDTO]: + """Retrieve a list of draft projects accessible to the user + + Get a list of draft projects accessible to the requesting user in the tenant. A project is accessible if it is owned by the user or shared to the user. + + :param var_with: The types of draft projects to include in the request response. * If empty, returns all the `Open` draft projects. * If `Open`, returns all Open draft projects. * If `Approval`, returns all draft projects in the approval stage. Changes cannot made in Approval projects. * If `Rejected`, returns all draft projects that have been rejected. Changes cannot be committed in Rejected projects. * If `Archived`, returns all draft projects that have been archived. Changes cannot be committed in Archived projects. + :type var_with: List[str] + :param limit: The number of projects to return per type. The maximum number of projects to retrieve per type is 1000. The default is 100. + :type limit: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_projects_serialize( + var_with=var_with, + limit=limit, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetProjectsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_projects_without_preload_content( + self, + var_with: Annotated[Optional[List[StrictStr]], Field(description="The types of draft projects to include in the request response. * If empty, returns all the `Open` draft projects. * If `Open`, returns all Open draft projects. * If `Approval`, returns all draft projects in the approval stage. Changes cannot made in Approval projects. * If `Rejected`, returns all draft projects that have been rejected. Changes cannot be committed in Rejected projects. * If `Archived`, returns all draft projects that have been archived. Changes cannot be committed in Archived projects.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of projects to return per type. The maximum number of projects to retrieve per type is 1000. The default is 100.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of draft projects accessible to the user + + Get a list of draft projects accessible to the requesting user in the tenant. A project is accessible if it is owned by the user or shared to the user. + + :param var_with: The types of draft projects to include in the request response. * If empty, returns all the `Open` draft projects. * If `Open`, returns all Open draft projects. * If `Approval`, returns all draft projects in the approval stage. Changes cannot made in Approval projects. * If `Rejected`, returns all draft projects that have been rejected. Changes cannot be committed in Rejected projects. * If `Archived`, returns all draft projects that have been archived. Changes cannot be committed in Archived projects. + :type var_with: List[str] + :param limit: The number of projects to return per type. The maximum number of projects to retrieve per type is 1000. The default is 100. + :type limit: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_projects_serialize( + var_with=var_with, + limit=limit, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingGetProjectsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_projects_serialize( + self, + var_with, + limit, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'with': 'multi', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if var_with is not None: + + _query_params.append(('with', var_with)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/projects', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def put_project_commits( + self, + project_id: Annotated[StrictStr, Field(description="The unique identifier of the draft project you want to import committed changes into.")], + admin_put_project_commits_request: AdminPutProjectCommitsRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProjectCommitsAPIResponseDTO: + """Import committed changes into a project + + Import a ZIP file that contains a list of committed changes into a draft project. The file must be an export from `POST /v1/admin/production-versions`. Use this API after making changes in a development environment to copy the changes to a draft project in your production environment. + + :param project_id: The unique identifier of the draft project you want to import committed changes into. (required) + :type project_id: str + :param admin_put_project_commits_request: (required) + :type admin_put_project_commits_request: AdminPutProjectCommitsRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_project_commits_serialize( + project_id=project_id, + admin_put_project_commits_request=admin_put_project_commits_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectCommitsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_project_commits_with_http_info( + self, + project_id: Annotated[StrictStr, Field(description="The unique identifier of the draft project you want to import committed changes into.")], + admin_put_project_commits_request: AdminPutProjectCommitsRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProjectCommitsAPIResponseDTO]: + """Import committed changes into a project + + Import a ZIP file that contains a list of committed changes into a draft project. The file must be an export from `POST /v1/admin/production-versions`. Use this API after making changes in a development environment to copy the changes to a draft project in your production environment. + + :param project_id: The unique identifier of the draft project you want to import committed changes into. (required) + :type project_id: str + :param admin_put_project_commits_request: (required) + :type admin_put_project_commits_request: AdminPutProjectCommitsRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_project_commits_serialize( + project_id=project_id, + admin_put_project_commits_request=admin_put_project_commits_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectCommitsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_project_commits_without_preload_content( + self, + project_id: Annotated[StrictStr, Field(description="The unique identifier of the draft project you want to import committed changes into.")], + admin_put_project_commits_request: AdminPutProjectCommitsRequest, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Import committed changes into a project + + Import a ZIP file that contains a list of committed changes into a draft project. The file must be an export from `POST /v1/admin/production-versions`. Use this API after making changes in a development environment to copy the changes to a draft project in your production environment. + + :param project_id: The unique identifier of the draft project you want to import committed changes into. (required) + :type project_id: str + :param admin_put_project_commits_request: (required) + :type admin_put_project_commits_request: AdminPutProjectCommitsRequest + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_project_commits_serialize( + project_id=project_id, + admin_put_project_commits_request=admin_put_project_commits_request, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectCommitsAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_project_commits_serialize( + self, + project_id, + admin_put_project_commits_request, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if project_id is not None: + _path_params['projectId'] = project_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_put_project_commits_request is not None: + _body_params = admin_put_project_commits_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/projects/{projectId}/commits', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def run_project_operation( + self, + project_id: StrictStr, + servicing_project_operation_request_dto: ServicingProjectOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingProjectOperationResponseDTO: + """Perform an operation on a draft project + + Perform operations on a draft project. The following operations are supported: * `commitAndPublish`: Commits project changes and publishes the project to production. + + :param project_id: (required) + :type project_id: str + :param servicing_project_operation_request_dto: (required) + :type servicing_project_operation_request_dto: ServicingProjectOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._run_project_operation_serialize( + project_id=project_id, + servicing_project_operation_request_dto=servicing_project_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def run_project_operation_with_http_info( + self, + project_id: StrictStr, + servicing_project_operation_request_dto: ServicingProjectOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingProjectOperationResponseDTO]: + """Perform an operation on a draft project + + Perform operations on a draft project. The following operations are supported: * `commitAndPublish`: Commits project changes and publishes the project to production. + + :param project_id: (required) + :type project_id: str + :param servicing_project_operation_request_dto: (required) + :type servicing_project_operation_request_dto: ServicingProjectOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._run_project_operation_serialize( + project_id=project_id, + servicing_project_operation_request_dto=servicing_project_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def run_project_operation_without_preload_content( + self, + project_id: StrictStr, + servicing_project_operation_request_dto: ServicingProjectOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Perform an operation on a draft project + + Perform operations on a draft project. The following operations are supported: * `commitAndPublish`: Commits project changes and publishes the project to production. + + :param project_id: (required) + :type project_id: str + :param servicing_project_operation_request_dto: (required) + :type servicing_project_operation_request_dto: ServicingProjectOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._run_project_operation_serialize( + project_id=project_id, + servicing_project_operation_request_dto=servicing_project_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingProjectOperationResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _run_project_operation_serialize( + self, + project_id, + servicing_project_operation_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if project_id is not None: + _path_params['projectId'] = project_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_project_operation_request_dto is not None: + _body_params = servicing_project_operation_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/projects/{projectId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/release_version_configuration_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/release_version_configuration_api.py new file mode 100644 index 0000000000..71449c4ca5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/release_version_configuration_api.py @@ -0,0 +1,835 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_product_releases_dto import AdminProductReleasesDTO +from visier_platform_sdk.models.admin_product_versions_dto import AdminProductVersionsDTO +from visier_platform_sdk.models.admin_product_versions_update_response_dto import AdminProductVersionsUpdateResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class ReleaseVersionConfigurationApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def get_available_releases( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminProductReleasesDTO: + """Retrieve available product releases + + Retrieve a list of release versions available for each product. The response returns information such as the unique ID of the product, the latest release version, and when the latest release version of the product will automatically be activated. Sometimes, the previous and latest versions are the same.
**Note:** 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). + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_available_releases_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminProductReleasesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_available_releases_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminProductReleasesDTO]: + """Retrieve available product releases + + Retrieve a list of release versions available for each product. The response returns information such as the unique ID of the product, the latest release version, and when the latest release version of the product will automatically be activated. Sometimes, the previous and latest versions are the same.
**Note:** 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). + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_available_releases_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminProductReleasesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_available_releases_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve available product releases + + Retrieve a list of release versions available for each product. The response returns information such as the unique ID of the product, the latest release version, and when the latest release version of the product will automatically be activated. Sometimes, the previous and latest versions are the same.
**Note:** 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). + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_available_releases_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminProductReleasesDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_available_releases_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/admin/product/releases', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_release_versions( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminProductVersionsDTO: + """Retrieve active product release versions + + Retrieve the currently active product release versions for a tenant.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_release_versions_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminProductVersionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_release_versions_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminProductVersionsDTO]: + """Retrieve active product release versions + + Retrieve the currently active product release versions for a tenant.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_release_versions_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminProductVersionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_release_versions_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve active product release versions + + Retrieve the currently active product release versions for a tenant.
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_release_versions_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminProductVersionsDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_release_versions_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/admin/product/versions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def set_release_versions( + self, + admin_product_versions_dto: AdminProductVersionsDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminProductVersionsUpdateResponseDTO: + """Activate product release versions + + Set the product release version to activate it on the selected tenants. Analytic tenants will automatically inherit the release version from the administrating tenant. You cannot rollback to a previous version.
**Note:** 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). + + :param admin_product_versions_dto: (required) + :type admin_product_versions_dto: AdminProductVersionsDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_release_versions_serialize( + admin_product_versions_dto=admin_product_versions_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminProductVersionsUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def set_release_versions_with_http_info( + self, + admin_product_versions_dto: AdminProductVersionsDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminProductVersionsUpdateResponseDTO]: + """Activate product release versions + + Set the product release version to activate it on the selected tenants. Analytic tenants will automatically inherit the release version from the administrating tenant. You cannot rollback to a previous version.
**Note:** 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). + + :param admin_product_versions_dto: (required) + :type admin_product_versions_dto: AdminProductVersionsDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_release_versions_serialize( + admin_product_versions_dto=admin_product_versions_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminProductVersionsUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def set_release_versions_without_preload_content( + self, + admin_product_versions_dto: AdminProductVersionsDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Activate product release versions + + Set the product release version to activate it on the selected tenants. Analytic tenants will automatically inherit the release version from the administrating tenant. You cannot rollback to a previous version.
**Note:** 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). + + :param admin_product_versions_dto: (required) + :type admin_product_versions_dto: AdminProductVersionsDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._set_release_versions_serialize( + admin_product_versions_dto=admin_product_versions_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminProductVersionsUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _set_release_versions_serialize( + self, + admin_product_versions_dto, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if admin_product_versions_dto is not None: + _body_params = admin_product_versions_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/v1alpha/admin/product/versions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/reporting_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/reporting_api.py new file mode 100644 index 0000000000..4dc84aa605 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/reporting_api.py @@ -0,0 +1,1757 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.analysis_common_report_create_request_dto import AnalysisCommonReportCreateRequestDTO +from visier_platform_sdk.models.analysis_common_report_dto import AnalysisCommonReportDTO +from visier_platform_sdk.models.analysis_common_report_delete_success_dto import AnalysisCommonReportDeleteSuccessDTO +from visier_platform_sdk.models.analysis_common_report_list_response_dto import AnalysisCommonReportListResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class ReportingApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def create_report( + self, + analysis_common_report_create_request_dto: AnalysisCommonReportCreateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnalysisCommonReportDTO: + """Create a report + + 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.
**Note:** 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). + + :param analysis_common_report_create_request_dto: (required) + :type analysis_common_report_create_request_dto: AnalysisCommonReportCreateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_report_serialize( + analysis_common_report_create_request_dto=analysis_common_report_create_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_report_with_http_info( + self, + analysis_common_report_create_request_dto: AnalysisCommonReportCreateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnalysisCommonReportDTO]: + """Create a report + + 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.
**Note:** 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). + + :param analysis_common_report_create_request_dto: (required) + :type analysis_common_report_create_request_dto: AnalysisCommonReportCreateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_report_serialize( + analysis_common_report_create_request_dto=analysis_common_report_create_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_report_without_preload_content( + self, + analysis_common_report_create_request_dto: AnalysisCommonReportCreateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a report + + 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.
**Note:** 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). + + :param analysis_common_report_create_request_dto: (required) + :type analysis_common_report_create_request_dto: AnalysisCommonReportCreateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_report_serialize( + analysis_common_report_create_request_dto=analysis_common_report_create_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_report_serialize( + self, + analysis_common_report_create_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if analysis_common_report_create_request_dto is not None: + _body_params = analysis_common_report_create_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/reporting/reports', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_report( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to delete.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnalysisCommonReportDeleteSuccessDTO: + """Delete a report + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to delete. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDeleteSuccessDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_report_with_http_info( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to delete.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnalysisCommonReportDeleteSuccessDTO]: + """Delete a report + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to delete. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDeleteSuccessDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_report_without_preload_content( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to delete.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a report + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to delete. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDeleteSuccessDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_report_serialize( + self, + report_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if report_id is not None: + _path_params['reportId'] = report_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1alpha/reporting/reports/{reportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def download_report( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to download.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> str: + """Download a report + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to download. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._download_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def download_report_with_http_info( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to download.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[str]: + """Download a report + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to download. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._download_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def download_report_without_preload_content( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to download.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Download a report + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to download. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._download_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _download_report_serialize( + self, + report_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if report_id is not None: + _path_params['reportId'] = report_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'text/csv', + 'application/zip', + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/reporting/report-data/{reportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def duplicate_report( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to duplicate.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnalysisCommonReportDTO: + """Duplicate a report + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to duplicate. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._duplicate_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def duplicate_report_with_http_info( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to duplicate.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnalysisCommonReportDTO]: + """Duplicate a report + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to duplicate. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._duplicate_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def duplicate_report_without_preload_content( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to duplicate.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Duplicate a report + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to duplicate. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._duplicate_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _duplicate_report_serialize( + self, + report_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if report_id is not None: + _path_params['reportId'] = report_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/reporting/reports/{reportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_report( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnalysisCommonReportDTO: + """Retrieve a report's details + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to retrieve. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_report_with_http_info( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnalysisCommonReportDTO]: + """Retrieve a report's details + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to retrieve. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_report_without_preload_content( + self, + report_id: Annotated[StrictStr, Field(description="The unique identifier of the report you want to retrieve.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a report's details + + 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`.
**Note:** 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). + + :param report_id: The unique identifier of the report you want to retrieve. (required) + :type report_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_report_serialize( + report_id=report_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_report_serialize( + self, + report_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if report_id is not None: + _path_params['reportId'] = report_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/reporting/reports/{reportId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_reports( + self, + 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, + 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, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnalysisCommonReportListResponseDTO: + """Retrieve a list of reports + + 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.
**Note:** 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). + + :param limit: Optionally, specify the number of reports to return. If omitted, the request uses the default value of 100. + :type limit: int + :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. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_reports_serialize( + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_reports_with_http_info( + self, + 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, + 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, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnalysisCommonReportListResponseDTO]: + """Retrieve a list of reports + + 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.
**Note:** 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). + + :param limit: Optionally, specify the number of reports to return. If omitted, the request uses the default value of 100. + :type limit: int + :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. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_reports_serialize( + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_reports_without_preload_content( + self, + 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, + 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, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of reports + + 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.
**Note:** 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). + + :param limit: Optionally, specify the number of reports to return. If omitted, the request uses the default value of 100. + :type limit: int + :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. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_reports_serialize( + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonReportListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_reports_serialize( + self, + limit, + start, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/reporting/reports', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/search_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/search_api.py new file mode 100644 index 0000000000..89aa226758 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/search_api.py @@ -0,0 +1,356 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.servicing_simple_document_header_search_response_dto import ServicingSimpleDocumentHeaderSearchResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class SearchApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def simple_search_document_headers( + self, + q: Annotated[Optional[StrictStr], Field(description="The search query string.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return. Defaults to 100.")] = None, + offset: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. Defaults to 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingSimpleDocumentHeaderSearchResponseDTO: + """Perform a simple search for Visier document headers + + Perform a simple search for Visier document headers, such as analysis titles. Simple search doesn't support keywords, Boolean expressions, or any other advanced search features. Example: `GET /v1alpha/search/simple/document-headers?q=My+Query&limit=10` returns the first 10 document headers that best match the query string `My Query`.
**Note:** 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). + + :param q: The search query string. + :type q: str + :param limit: The maximum number of results to return. Defaults to 100. + :type limit: int + :param offset: The index to start retrieving results from, also known as offset. Defaults to 0. + :type offset: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._simple_search_document_headers_serialize( + q=q, + limit=limit, + offset=offset, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingSimpleDocumentHeaderSearchResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def simple_search_document_headers_with_http_info( + self, + q: Annotated[Optional[StrictStr], Field(description="The search query string.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return. Defaults to 100.")] = None, + offset: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. Defaults to 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingSimpleDocumentHeaderSearchResponseDTO]: + """Perform a simple search for Visier document headers + + Perform a simple search for Visier document headers, such as analysis titles. Simple search doesn't support keywords, Boolean expressions, or any other advanced search features. Example: `GET /v1alpha/search/simple/document-headers?q=My+Query&limit=10` returns the first 10 document headers that best match the query string `My Query`.
**Note:** 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). + + :param q: The search query string. + :type q: str + :param limit: The maximum number of results to return. Defaults to 100. + :type limit: int + :param offset: The index to start retrieving results from, also known as offset. Defaults to 0. + :type offset: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._simple_search_document_headers_serialize( + q=q, + limit=limit, + offset=offset, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingSimpleDocumentHeaderSearchResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def simple_search_document_headers_without_preload_content( + self, + q: Annotated[Optional[StrictStr], Field(description="The search query string.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of results to return. Defaults to 100.")] = None, + offset: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. Defaults to 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Perform a simple search for Visier document headers + + Perform a simple search for Visier document headers, such as analysis titles. Simple search doesn't support keywords, Boolean expressions, or any other advanced search features. Example: `GET /v1alpha/search/simple/document-headers?q=My+Query&limit=10` returns the first 10 document headers that best match the query string `My Query`.
**Note:** 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). + + :param q: The search query string. + :type q: str + :param limit: The maximum number of results to return. Defaults to 100. + :type limit: int + :param offset: The index to start retrieving results from, also known as offset. Defaults to 0. + :type offset: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._simple_search_document_headers_serialize( + q=q, + limit=limit, + offset=offset, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingSimpleDocumentHeaderSearchResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _simple_search_document_headers_serialize( + self, + q, + limit, + offset, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if q is not None: + + _query_params.append(('q', q)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if offset is not None: + + _query_params.append(('offset', offset)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/search/simple/document-headers', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/skills_library_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/skills_library_api.py new file mode 100644 index 0000000000..138e871e83 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/skills_library_api.py @@ -0,0 +1,2632 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr +from typing import List, Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.extracted_skill import ExtractedSkill +from visier_platform_sdk.models.skill import Skill +from visier_platform_sdk.models.skill_category import SkillCategory +from visier_platform_sdk.models.skill_category_entry import SkillCategoryEntry +from visier_platform_sdk.models.skill_entry import SkillEntry +from visier_platform_sdk.models.skill_extraction_input import SkillExtractionInput +from visier_platform_sdk.models.skill_group import SkillGroup +from visier_platform_sdk.models.skill_group_entry import SkillGroupEntry +from visier_platform_sdk.models.skill_match_input import SkillMatchInput + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class SkillsLibraryApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def extract_skills( + self, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + skill_extraction_input: Annotated[Optional[SkillExtractionInput], Field(description="The text to extract skills from. The minimum length is 4 characters and the maximum length is 7500 characters. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[ExtractedSkill]: + """Extract skills from text + + Extract the relevant skills from text such as job descriptions and course outlines. + + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param skill_extraction_input: The text to extract skills from. The minimum length is 4 characters and the maximum length is 7500 characters. + :type skill_extraction_input: SkillExtractionInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._extract_skills_serialize( + accept_language=accept_language, + skill_extraction_input=skill_extraction_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ExtractedSkill]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def extract_skills_with_http_info( + self, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + skill_extraction_input: Annotated[Optional[SkillExtractionInput], Field(description="The text to extract skills from. The minimum length is 4 characters and the maximum length is 7500 characters. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[ExtractedSkill]]: + """Extract skills from text + + Extract the relevant skills from text such as job descriptions and course outlines. + + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param skill_extraction_input: The text to extract skills from. The minimum length is 4 characters and the maximum length is 7500 characters. + :type skill_extraction_input: SkillExtractionInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._extract_skills_serialize( + accept_language=accept_language, + skill_extraction_input=skill_extraction_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ExtractedSkill]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def extract_skills_without_preload_content( + self, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + skill_extraction_input: Annotated[Optional[SkillExtractionInput], Field(description="The text to extract skills from. The minimum length is 4 characters and the maximum length is 7500 characters. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Extract skills from text + + Extract the relevant skills from text such as job descriptions and course outlines. + + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param skill_extraction_input: The text to extract skills from. The minimum length is 4 characters and the maximum length is 7500 characters. + :type skill_extraction_input: SkillExtractionInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._extract_skills_serialize( + accept_language=accept_language, + skill_extraction_input=skill_extraction_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[ExtractedSkill]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _extract_skills_serialize( + self, + accept_language, + skill_extraction_input, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + if skill_extraction_input is not None: + _body_params = skill_extraction_input + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/skills/extract', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_skill( + self, + id: Annotated[StrictStr, Field(description="The ID of the skill to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> Skill: + """Get skill details by ID + + If you know the ID of a skill, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, and alternative names. + + :param id: The ID of the skill to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_skill_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Skill", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_skill_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ID of the skill to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[Skill]: + """Get skill details by ID + + If you know the ID of a skill, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, and alternative names. + + :param id: The ID of the skill to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_skill_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Skill", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_skill_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ID of the skill to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get skill details by ID + + If you know the ID of a skill, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, and alternative names. + + :param id: The ID of the skill to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_skill_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Skill", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_skill_serialize( + self, + id, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/skills/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_skill_category( + self, + id: Annotated[StrictStr, Field(description="The ID of the skill category to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SkillCategory: + """Get skill category details by ID + + If you know the ID of a skill category, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, and alternative names. + + :param id: The ID of the skill category to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_skill_category_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SkillCategory", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_skill_category_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ID of the skill category to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SkillCategory]: + """Get skill category details by ID + + If you know the ID of a skill category, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, and alternative names. + + :param id: The ID of the skill category to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_skill_category_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SkillCategory", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_skill_category_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ID of the skill category to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get skill category details by ID + + If you know the ID of a skill category, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, and alternative names. + + :param id: The ID of the skill category to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_skill_category_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SkillCategory", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_skill_category_serialize( + self, + id, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/skill-categories/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_skill_group( + self, + id: Annotated[StrictStr, Field(description="The ID of the skill group to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SkillGroup: + """Get skill group details by ID + + If you know the ID of a skill group, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, and alternative names. + + :param id: The ID of the skill group to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_skill_group_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SkillGroup", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_skill_group_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The ID of the skill group to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SkillGroup]: + """Get skill group details by ID + + If you know the ID of a skill group, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, and alternative names. + + :param id: The ID of the skill group to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_skill_group_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SkillGroup", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_skill_group_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The ID of the skill group to retrieve details for. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get skill group details by ID + + If you know the ID of a skill group, use this endpoint to retrieve information such as display name, description, Automation Index, Remote Work Index, and alternative names. + + :param id: The ID of the skill group to retrieve details for. (required) + :type id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_skill_group_serialize( + id=id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SkillGroup", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_skill_group_serialize( + self, + id, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = id + # process the query parameters + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/skill-groups/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_skill_categories( + self, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[SkillCategoryEntry]: + """Retrieve a list of skill categories + + Use this endpoint to retrieve all skill categories in Visier's Skills Library. + + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_skill_categories_serialize( + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillCategoryEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_skill_categories_with_http_info( + self, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[SkillCategoryEntry]]: + """Retrieve a list of skill categories + + Use this endpoint to retrieve all skill categories in Visier's Skills Library. + + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_skill_categories_serialize( + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillCategoryEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_skill_categories_without_preload_content( + self, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of skill categories + + Use this endpoint to retrieve all skill categories in Visier's Skills Library. + + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_skill_categories_serialize( + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillCategoryEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_skill_categories_serialize( + self, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/skill-categories', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_skill_groups( + self, + skill_category_id: Annotated[Optional[StrictStr], Field(description="Filter only skills that belong to a certain skill category. ")] = None, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[SkillGroupEntry]: + """Retrieve a list of skill groups + + Use this endpoint to retrieve all skill groups in Visier's Skills Library. + + :param skill_category_id: Filter only skills that belong to a certain skill category. + :type skill_category_id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_skill_groups_serialize( + skill_category_id=skill_category_id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillGroupEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_skill_groups_with_http_info( + self, + skill_category_id: Annotated[Optional[StrictStr], Field(description="Filter only skills that belong to a certain skill category. ")] = None, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[SkillGroupEntry]]: + """Retrieve a list of skill groups + + Use this endpoint to retrieve all skill groups in Visier's Skills Library. + + :param skill_category_id: Filter only skills that belong to a certain skill category. + :type skill_category_id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_skill_groups_serialize( + skill_category_id=skill_category_id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillGroupEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_skill_groups_without_preload_content( + self, + skill_category_id: Annotated[Optional[StrictStr], Field(description="Filter only skills that belong to a certain skill category. ")] = None, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of skill groups + + Use this endpoint to retrieve all skill groups in Visier's Skills Library. + + :param skill_category_id: Filter only skills that belong to a certain skill category. + :type skill_category_id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_skill_groups_serialize( + skill_category_id=skill_category_id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillGroupEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_skill_groups_serialize( + self, + skill_category_id, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if skill_category_id is not None: + + _query_params.append(('skillCategoryId', skill_category_id)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/skill-groups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_skills( + self, + skill_group_id: Annotated[Optional[StrictStr], Field(description="Filter only skills that belong to a certain skill group. ")] = None, + skill_category_id: Annotated[Optional[StrictStr], Field(description="Filter only skills that belong to a certain skill category. ")] = None, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[SkillEntry]: + """Retrieve a list of skills + + Use this endpoint to retrieve all skills in Visier's Skills Library. + + :param skill_group_id: Filter only skills that belong to a certain skill group. + :type skill_group_id: str + :param skill_category_id: Filter only skills that belong to a certain skill category. + :type skill_category_id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_skills_serialize( + skill_group_id=skill_group_id, + skill_category_id=skill_category_id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_skills_with_http_info( + self, + skill_group_id: Annotated[Optional[StrictStr], Field(description="Filter only skills that belong to a certain skill group. ")] = None, + skill_category_id: Annotated[Optional[StrictStr], Field(description="Filter only skills that belong to a certain skill category. ")] = None, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[SkillEntry]]: + """Retrieve a list of skills + + Use this endpoint to retrieve all skills in Visier's Skills Library. + + :param skill_group_id: Filter only skills that belong to a certain skill group. + :type skill_group_id: str + :param skill_category_id: Filter only skills that belong to a certain skill category. + :type skill_category_id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_skills_serialize( + skill_group_id=skill_group_id, + skill_category_id=skill_category_id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_skills_without_preload_content( + self, + skill_group_id: Annotated[Optional[StrictStr], Field(description="Filter only skills that belong to a certain skill group. ")] = None, + skill_category_id: Annotated[Optional[StrictStr], Field(description="Filter only skills that belong to a certain skill category. ")] = None, + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of skills + + Use this endpoint to retrieve all skills in Visier's Skills Library. + + :param skill_group_id: Filter only skills that belong to a certain skill group. + :type skill_group_id: str + :param skill_category_id: Filter only skills that belong to a certain skill category. + :type skill_category_id: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_skills_serialize( + skill_group_id=skill_group_id, + skill_category_id=skill_category_id, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_skills_serialize( + self, + skill_group_id, + skill_category_id, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if skill_group_id is not None: + + _query_params.append(('skillGroupId', skill_group_id)) + + if skill_category_id is not None: + + _query_params.append(('skillCategoryId', skill_category_id)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/skills', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def match_skills( + self, + skill_match_input: Annotated[Optional[SkillMatchInput], Field(description="The skill set and the group of skill sets (targets) to be matched. The skills included in each skill set are entered in the following format [skill_id, score]. The score represents how prevalent the skill was in the source and is used as a weighting factor when determining the best match. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[int]: + """Match a skill set to a group of skill sets (targets) + + Find the best match between a skill set and a group of skill sets (targets). The response returns a ranking of the targets with the best match appearing at the top of the list. + + :param skill_match_input: The skill set and the group of skill sets (targets) to be matched. The skills included in each skill set are entered in the following format [skill_id, score]. The score represents how prevalent the skill was in the source and is used as a weighting factor when determining the best match. + :type skill_match_input: SkillMatchInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._match_skills_serialize( + skill_match_input=skill_match_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[int]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def match_skills_with_http_info( + self, + skill_match_input: Annotated[Optional[SkillMatchInput], Field(description="The skill set and the group of skill sets (targets) to be matched. The skills included in each skill set are entered in the following format [skill_id, score]. The score represents how prevalent the skill was in the source and is used as a weighting factor when determining the best match. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[int]]: + """Match a skill set to a group of skill sets (targets) + + Find the best match between a skill set and a group of skill sets (targets). The response returns a ranking of the targets with the best match appearing at the top of the list. + + :param skill_match_input: The skill set and the group of skill sets (targets) to be matched. The skills included in each skill set are entered in the following format [skill_id, score]. The score represents how prevalent the skill was in the source and is used as a weighting factor when determining the best match. + :type skill_match_input: SkillMatchInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._match_skills_serialize( + skill_match_input=skill_match_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[int]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def match_skills_without_preload_content( + self, + skill_match_input: Annotated[Optional[SkillMatchInput], Field(description="The skill set and the group of skill sets (targets) to be matched. The skills included in each skill set are entered in the following format [skill_id, score]. The score represents how prevalent the skill was in the source and is used as a weighting factor when determining the best match. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Match a skill set to a group of skill sets (targets) + + Find the best match between a skill set and a group of skill sets (targets). The response returns a ranking of the targets with the best match appearing at the top of the list. + + :param skill_match_input: The skill set and the group of skill sets (targets) to be matched. The skills included in each skill set are entered in the following format [skill_id, score]. The score represents how prevalent the skill was in the source and is used as a weighting factor when determining the best match. + :type skill_match_input: SkillMatchInput + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._match_skills_serialize( + skill_match_input=skill_match_input, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[int]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _match_skills_serialize( + self, + skill_match_input, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if skill_match_input is not None: + _body_params = skill_match_input + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/skills/match', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def search_skill( + self, + term: Annotated[StrictStr, Field(description="The term to search for. The search term must be URL encoded and the minimum length is 3 characters. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[SkillEntry]: + """Search skills + + Retrieve a list of skills that match a specified search term. + + :param term: The term to search for. The search term must be URL encoded and the minimum length is 3 characters. (required) + :type term: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_skill_serialize( + term=term, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def search_skill_with_http_info( + self, + term: Annotated[StrictStr, Field(description="The term to search for. The search term must be URL encoded and the minimum length is 3 characters. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[SkillEntry]]: + """Search skills + + Retrieve a list of skills that match a specified search term. + + :param term: The term to search for. The search term must be URL encoded and the minimum length is 3 characters. (required) + :type term: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_skill_serialize( + term=term, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def search_skill_without_preload_content( + self, + term: Annotated[StrictStr, Field(description="The term to search for. The search term must be URL encoded and the minimum length is 3 characters. ")], + accept_language: Annotated[Optional[StrictStr], Field(description="Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. ")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Search skills + + Retrieve a list of skills that match a specified search term. + + :param term: The term to search for. The search term must be URL encoded and the minimum length is 3 characters. (required) + :type term: str + :param accept_language: Allows you to specify if you want the output to be in one of the accepted languages. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is English. + :type accept_language: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._search_skill_serialize( + term=term, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[SkillEntry]", + '400': "ApiError", + '500': "ApiError", + '504': "ApiError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _search_skill_serialize( + self, + term, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if term is not None: + + _query_params.append(('term', term)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'api_key' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/skills/search', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/source_files_download_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/source_files_download_api.py new file mode 100644 index 0000000000..7f82558c15 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/source_files_download_api.py @@ -0,0 +1,335 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.designer_download_source_files_dto import DesignerDownloadSourceFilesDTO +from visier_platform_sdk.models.designer_download_source_files_response_dto import DesignerDownloadSourceFilesResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class SourceFilesDownloadApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def download_source_files( + self, + designer_download_source_files_dto: DesignerDownloadSourceFilesDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerDownloadSourceFilesResponseDTO: + """Download source files + + Download a tenant's source files. You can download all included source files or specify a list of sources to download. Use object names or unique identifiers to specify the list of sources. Excluded source files will not be downloaded. If `minTimestamp` and `maxTimestamp` are defined, downloads the source files uploaded within the specified time range for all sources or the specified sources. Administrating tenants can specify the tenant from which to download sources using the `TargetTenantID` header. **Note:** 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). + + :param designer_download_source_files_dto: (required) + :type designer_download_source_files_dto: DesignerDownloadSourceFilesDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._download_source_files_serialize( + designer_download_source_files_dto=designer_download_source_files_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDownloadSourceFilesResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def download_source_files_with_http_info( + self, + designer_download_source_files_dto: DesignerDownloadSourceFilesDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerDownloadSourceFilesResponseDTO]: + """Download source files + + Download a tenant's source files. You can download all included source files or specify a list of sources to download. Use object names or unique identifiers to specify the list of sources. Excluded source files will not be downloaded. If `minTimestamp` and `maxTimestamp` are defined, downloads the source files uploaded within the specified time range for all sources or the specified sources. Administrating tenants can specify the tenant from which to download sources using the `TargetTenantID` header. **Note:** 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). + + :param designer_download_source_files_dto: (required) + :type designer_download_source_files_dto: DesignerDownloadSourceFilesDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._download_source_files_serialize( + designer_download_source_files_dto=designer_download_source_files_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDownloadSourceFilesResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def download_source_files_without_preload_content( + self, + designer_download_source_files_dto: DesignerDownloadSourceFilesDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Download source files + + Download a tenant's source files. You can download all included source files or specify a list of sources to download. Use object names or unique identifiers to specify the list of sources. Excluded source files will not be downloaded. If `minTimestamp` and `maxTimestamp` are defined, downloads the source files uploaded within the specified time range for all sources or the specified sources. Administrating tenants can specify the tenant from which to download sources using the `TargetTenantID` header. **Note:** 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). + + :param designer_download_source_files_dto: (required) + :type designer_download_source_files_dto: DesignerDownloadSourceFilesDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._download_source_files_serialize( + designer_download_source_files_dto=designer_download_source_files_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerDownloadSourceFilesResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _download_source_files_serialize( + self, + designer_download_source_files_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if designer_download_source_files_dto is not None: + _body_params = designer_download_source_files_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'application/zip' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/op/data/source-files', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/sources_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/sources_api.py new file mode 100644 index 0000000000..0dacb8d38c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/sources_api.py @@ -0,0 +1,652 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictBytes, StrictStr +from typing import Any, Dict, Optional, Tuple, Union +from typing_extensions import Annotated +from visier_platform_sdk.models.servicing_sources_api_operation_request_dto import ServicingSourcesAPIOperationRequestDTO +from visier_platform_sdk.models.sources_api_put_response_dto import SourcesAPIPutResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class SourcesApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def put_sources( + self, + body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], + replace_all_existing_sources: Annotated[Optional[StrictBool], Field(description="If `false`, adds the sources from the ZIP to the sources in the target tenant. If `true`, removes all sources in the target tenant and adds the sources from the ZIP. Default is `false`.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SourcesAPIPutResponseDTO: + """Import a list of sources + + Import a list of sources in ZIP format. The file must be an export from `POST /v1alpha/admin/sources`. Use this API after making changes in a development environment to copy the changes to a draft project in your production environment.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param body: (required) + :type body: bytearray + :param replace_all_existing_sources: If `false`, adds the sources from the ZIP to the sources in the target tenant. If `true`, removes all sources in the target tenant and adds the sources from the ZIP. Default is `false`. + :type replace_all_existing_sources: bool + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_sources_serialize( + body=body, + replace_all_existing_sources=replace_all_existing_sources, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SourcesAPIPutResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_sources_with_http_info( + self, + body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], + replace_all_existing_sources: Annotated[Optional[StrictBool], Field(description="If `false`, adds the sources from the ZIP to the sources in the target tenant. If `true`, removes all sources in the target tenant and adds the sources from the ZIP. Default is `false`.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SourcesAPIPutResponseDTO]: + """Import a list of sources + + Import a list of sources in ZIP format. The file must be an export from `POST /v1alpha/admin/sources`. Use this API after making changes in a development environment to copy the changes to a draft project in your production environment.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param body: (required) + :type body: bytearray + :param replace_all_existing_sources: If `false`, adds the sources from the ZIP to the sources in the target tenant. If `true`, removes all sources in the target tenant and adds the sources from the ZIP. Default is `false`. + :type replace_all_existing_sources: bool + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_sources_serialize( + body=body, + replace_all_existing_sources=replace_all_existing_sources, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SourcesAPIPutResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_sources_without_preload_content( + self, + body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], + replace_all_existing_sources: Annotated[Optional[StrictBool], Field(description="If `false`, adds the sources from the ZIP to the sources in the target tenant. If `true`, removes all sources in the target tenant and adds the sources from the ZIP. Default is `false`.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Import a list of sources + + Import a list of sources in ZIP format. The file must be an export from `POST /v1alpha/admin/sources`. Use this API after making changes in a development environment to copy the changes to a draft project in your production environment.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param body: (required) + :type body: bytearray + :param replace_all_existing_sources: If `false`, adds the sources from the ZIP to the sources in the target tenant. If `true`, removes all sources in the target tenant and adds the sources from the ZIP. Default is `false`. + :type replace_all_existing_sources: bool + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_sources_serialize( + body=body, + replace_all_existing_sources=replace_all_existing_sources, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SourcesAPIPutResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_sources_serialize( + self, + body, + replace_all_existing_sources, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if replace_all_existing_sources is not None: + + _query_params.append(('replaceAllExistingSources', replace_all_existing_sources)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if body is not None: + # convert to byte array if the input is a file name (str) + if isinstance(body, str): + with open(body, "rb") as _fp: + _body_params = _fp.read() + elif isinstance(body, tuple): + # drop the filename from the tuple + _body_params = body[1] + else: + _body_params = body + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/zip' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1beta/admin/sources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def run_sources_operation( + self, + servicing_sources_api_operation_request_dto: ServicingSourcesAPIOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> object: + """Perform an operation on all sources + + Perform operations on all sources. The following operations are supported: * `exportSources`: Export a ZIP file that contains a list of all sources in the application.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param servicing_sources_api_operation_request_dto: (required) + :type servicing_sources_api_operation_request_dto: ServicingSourcesAPIOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._run_sources_operation_serialize( + servicing_sources_api_operation_request_dto=servicing_sources_api_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def run_sources_operation_with_http_info( + self, + servicing_sources_api_operation_request_dto: ServicingSourcesAPIOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[object]: + """Perform an operation on all sources + + Perform operations on all sources. The following operations are supported: * `exportSources`: Export a ZIP file that contains a list of all sources in the application.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param servicing_sources_api_operation_request_dto: (required) + :type servicing_sources_api_operation_request_dto: ServicingSourcesAPIOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._run_sources_operation_serialize( + servicing_sources_api_operation_request_dto=servicing_sources_api_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def run_sources_operation_without_preload_content( + self, + servicing_sources_api_operation_request_dto: ServicingSourcesAPIOperationRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Perform an operation on all sources + + Perform operations on all sources. The following operations are supported: * `exportSources`: Export a ZIP file that contains a list of all sources in the application.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param servicing_sources_api_operation_request_dto: (required) + :type servicing_sources_api_operation_request_dto: ServicingSourcesAPIOperationRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._run_sources_operation_serialize( + servicing_sources_api_operation_request_dto=servicing_sources_api_operation_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _run_sources_operation_serialize( + self, + servicing_sources_api_operation_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_sources_api_operation_request_dto is not None: + _body_params = servicing_sources_api_operation_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1beta/admin/sources', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/system_status_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/system_status_api.py new file mode 100644 index 0000000000..73fb043d6d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/system_status_api.py @@ -0,0 +1,570 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.systemstatus_system_status_dto import SystemstatusSystemStatusDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class SystemStatusApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def post_system_status( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SystemstatusSystemStatusDTO: + """Check the overall current status of Visier's systems + + Check the current overall status of Visier's systems. The overall status is one of: * ``UP`` : All systems are operational. * `DOWN`: At least one system is not fully operational. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._post_system_status_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemstatusSystemStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def post_system_status_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SystemstatusSystemStatusDTO]: + """Check the overall current status of Visier's systems + + Check the current overall status of Visier's systems. The overall status is one of: * ``UP`` : All systems are operational. * `DOWN`: At least one system is not fully operational. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._post_system_status_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemstatusSystemStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def post_system_status_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Check the overall current status of Visier's systems + + Check the current overall status of Visier's systems. The overall status is one of: * ``UP`` : All systems are operational. * `DOWN`: At least one system is not fully operational. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._post_system_status_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemstatusSystemStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _post_system_status_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/system-status', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def system_status( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SystemstatusSystemStatusDTO: + """Check the overall current status of Visier's systems + + Check the current overall status of Visier's systems. The overall status is one of: * ``UP`` : All systems are operational. * `DOWN`: At least one system is not fully operational. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._system_status_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemstatusSystemStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def system_status_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SystemstatusSystemStatusDTO]: + """Check the overall current status of Visier's systems + + Check the current overall status of Visier's systems. The overall status is one of: * ``UP`` : All systems are operational. * `DOWN`: At least one system is not fully operational. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._system_status_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemstatusSystemStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def system_status_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Check the overall current status of Visier's systems + + Check the current overall status of Visier's systems. The overall status is one of: * ``UP`` : All systems are operational. * `DOWN`: At least one system is not fully operational. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._system_status_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemstatusSystemStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _system_status_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/system-status', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/tenants_v1_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/tenants_v1_api.py new file mode 100644 index 0000000000..7a8589b5e8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/tenants_v1_api.py @@ -0,0 +1,2836 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_all_tenants_status_apidto import AdminAllTenantsStatusAPIDTO +from visier_platform_sdk.models.admin_batch_tenant_provision_apidto import AdminBatchTenantProvisionAPIDTO +from visier_platform_sdk.models.admin_tenant_detail_apidto import AdminTenantDetailAPIDTO +from visier_platform_sdk.models.admin_tenant_provision_apidto import AdminTenantProvisionAPIDTO +from visier_platform_sdk.models.admin_tenant_status_apidto import AdminTenantStatusAPIDTO +from visier_platform_sdk.models.admin_update_tenant_model import AdminUpdateTenantModel +from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_dto import DpAutomationTenantPreviewEntriesSummaryDTO +from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_list_dto import DpAutomationTenantPreviewEntriesSummaryListDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class TenantsV1Api: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def add_tenant( + self, + admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantProvisionAPIDTO: + """Add an analytic tenant + + Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you. + + :param admin_tenant_provision_apidto: (required) + :type admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_tenant_serialize( + admin_tenant_provision_apidto=admin_tenant_provision_apidto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantProvisionAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def add_tenant_with_http_info( + self, + admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantProvisionAPIDTO]: + """Add an analytic tenant + + Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you. + + :param admin_tenant_provision_apidto: (required) + :type admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_tenant_serialize( + admin_tenant_provision_apidto=admin_tenant_provision_apidto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantProvisionAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def add_tenant_without_preload_content( + self, + admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add an analytic tenant + + Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you. + + :param admin_tenant_provision_apidto: (required) + :type admin_tenant_provision_apidto: AdminTenantProvisionAPIDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_tenant_serialize( + admin_tenant_provision_apidto=admin_tenant_provision_apidto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantProvisionAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _add_tenant_serialize( + self, + admin_tenant_provision_apidto, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if admin_tenant_provision_apidto is not None: + _body_params = admin_tenant_provision_apidto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def add_tenants( + self, + admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminBatchTenantProvisionAPIDTO: + """Add analytic tenants + + Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create one or more analytic tenants and identify the applications assigned to the tenants. The maximum number of tenants to create in one request is 200. Contact Visier Support to determine the list of modules allocated to you. + + :param admin_batch_tenant_provision_apidto: (required) + :type admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_tenants_serialize( + admin_batch_tenant_provision_apidto=admin_batch_tenant_provision_apidto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminBatchTenantProvisionAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def add_tenants_with_http_info( + self, + admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminBatchTenantProvisionAPIDTO]: + """Add analytic tenants + + Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create one or more analytic tenants and identify the applications assigned to the tenants. The maximum number of tenants to create in one request is 200. Contact Visier Support to determine the list of modules allocated to you. + + :param admin_batch_tenant_provision_apidto: (required) + :type admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_tenants_serialize( + admin_batch_tenant_provision_apidto=admin_batch_tenant_provision_apidto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminBatchTenantProvisionAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def add_tenants_without_preload_content( + self, + admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add analytic tenants + + Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create one or more analytic tenants and identify the applications assigned to the tenants. The maximum number of tenants to create in one request is 200. Contact Visier Support to determine the list of modules allocated to you. + + :param admin_batch_tenant_provision_apidto: (required) + :type admin_batch_tenant_provision_apidto: AdminBatchTenantProvisionAPIDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_tenants_serialize( + admin_batch_tenant_provision_apidto=admin_batch_tenant_provision_apidto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminBatchTenantProvisionAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _add_tenants_serialize( + self, + admin_batch_tenant_provision_apidto, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if admin_batch_tenant_provision_apidto is not None: + _body_params = admin_batch_tenant_provision_apidto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/tenants/batch', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_tenant( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantStatusAPIDTO: + """Deprovision an analytic tenant + + Warning! Deprovisioning an analytic tenant is not reversible. Before deprovisioning, you must disable an analytic tenant. For more information, see **`/v1/admin/tenants/{tenantId}/disable`**. This API removes an analytic tenant permanently from the Visier system. If you are unsure whether an analytic tenant may be re-enabled on any of the Visier modules at any time, you may instead want to disable the analytic tenant. If successful, the response returns the status \"Deprovisioned\". This indicates that the tenant is scheduled for deprovisioning, which may take several days to complete. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_tenant_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantStatusAPIDTO]: + """Deprovision an analytic tenant + + Warning! Deprovisioning an analytic tenant is not reversible. Before deprovisioning, you must disable an analytic tenant. For more information, see **`/v1/admin/tenants/{tenantId}/disable`**. This API removes an analytic tenant permanently from the Visier system. If you are unsure whether an analytic tenant may be re-enabled on any of the Visier modules at any time, you may instead want to disable the analytic tenant. If successful, the response returns the status \"Deprovisioned\". This indicates that the tenant is scheduled for deprovisioning, which may take several days to complete. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_tenant_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Deprovision an analytic tenant + + Warning! Deprovisioning an analytic tenant is not reversible. Before deprovisioning, you must disable an analytic tenant. For more information, see **`/v1/admin/tenants/{tenantId}/disable`**. This API removes an analytic tenant permanently from the Visier system. If you are unsure whether an analytic tenant may be re-enabled on any of the Visier modules at any time, you may instead want to disable the analytic tenant. If successful, the response returns the status \"Deprovisioned\". This indicates that the tenant is scheduled for deprovisioning, which may take several days to complete. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_tenant_serialize( + self, + tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/admin/tenants/{tenantId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def disable_tenant( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantStatusAPIDTO: + """Disable an analytic tenant + + Disable an analytic tenant and remove access to Visier visualizations for the tenant's users. You must disable an analytic tenant before deprovisioning, or removing, it from the system. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._disable_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def disable_tenant_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantStatusAPIDTO]: + """Disable an analytic tenant + + Disable an analytic tenant and remove access to Visier visualizations for the tenant's users. You must disable an analytic tenant before deprovisioning, or removing, it from the system. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._disable_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def disable_tenant_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Disable an analytic tenant + + Disable an analytic tenant and remove access to Visier visualizations for the tenant's users. You must disable an analytic tenant before deprovisioning, or removing, it from the system. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._disable_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _disable_tenant_serialize( + self, + tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/tenants/{tenantId}/disable', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def enable_tenant( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantStatusAPIDTO: + """Enable an analytic tenant + + An analytic tenant is enabled when you provision or create the tenant. Use this API to enable a tenant that you have specifically disabled; for example, if you previously did not want that tenant to have access to Visier visualizations, but now do. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._enable_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def enable_tenant_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantStatusAPIDTO]: + """Enable an analytic tenant + + An analytic tenant is enabled when you provision or create the tenant. Use this API to enable a tenant that you have specifically disabled; for example, if you previously did not want that tenant to have access to Visier visualizations, but now do. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._enable_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def enable_tenant_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Enable an analytic tenant + + An analytic tenant is enabled when you provision or create the tenant. Use this API to enable a tenant that you have specifically disabled; for example, if you previously did not want that tenant to have access to Visier visualizations, but now do. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._enable_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _enable_tenant_serialize( + self, + tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/tenants/{tenantId}/enable', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_tenant( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantDetailAPIDTO: + """Retrieve an analytic tenant's details + + Retrieve all details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantDetailAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_tenant_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantDetailAPIDTO]: + """Retrieve an analytic tenant's details + + Retrieve all details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantDetailAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_tenant_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an analytic tenant's details + + Retrieve all details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tenant_serialize( + tenant_id=tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantDetailAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_tenant_serialize( + self, + tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/tenants/{tenantId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_tenants( + self, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + details: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns information about the data version and modules.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminAllTenantsStatusAPIDTO: + """Retrieve a list of all analytic tenants + + Retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested. + + :param limit: The limit of analytic tenant details to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param details: If `true`, the response returns information about the data version and modules. + :type details: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tenants_serialize( + limit=limit, + start=start, + details=details, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminAllTenantsStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_tenants_with_http_info( + self, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + details: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns information about the data version and modules.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminAllTenantsStatusAPIDTO]: + """Retrieve a list of all analytic tenants + + Retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested. + + :param limit: The limit of analytic tenant details to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param details: If `true`, the response returns information about the data version and modules. + :type details: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tenants_serialize( + limit=limit, + start=start, + details=details, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminAllTenantsStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_tenants_without_preload_content( + self, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + details: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns information about the data version and modules.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all analytic tenants + + Retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested. + + :param limit: The limit of analytic tenant details to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param details: If `true`, the response returns information about the data version and modules. + :type details: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_tenants_serialize( + limit=limit, + start=start, + details=details, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminAllTenantsStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_tenants_serialize( + self, + limit, + start, + details, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + if details is not None: + + _query_params.append(('details', details)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_tenant( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to update.")], + admin_update_tenant_model: AdminUpdateTenantModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantProvisionAPIDTO: + """Update an analytic tenant + + You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. You can use this API to update any field on an analytic tenant, except `tenantCode`. + + :param tenant_id: The ID of the tenant to update. (required) + :type tenant_id: str + :param admin_update_tenant_model: (required) + :type admin_update_tenant_model: AdminUpdateTenantModel + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_tenant_serialize( + tenant_id=tenant_id, + admin_update_tenant_model=admin_update_tenant_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantProvisionAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_tenant_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to update.")], + admin_update_tenant_model: AdminUpdateTenantModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantProvisionAPIDTO]: + """Update an analytic tenant + + You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. You can use this API to update any field on an analytic tenant, except `tenantCode`. + + :param tenant_id: The ID of the tenant to update. (required) + :type tenant_id: str + :param admin_update_tenant_model: (required) + :type admin_update_tenant_model: AdminUpdateTenantModel + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_tenant_serialize( + tenant_id=tenant_id, + admin_update_tenant_model=admin_update_tenant_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantProvisionAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_tenant_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to update.")], + admin_update_tenant_model: AdminUpdateTenantModel, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update an analytic tenant + + You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. You can use this API to update any field on an analytic tenant, except `tenantCode`. + + :param tenant_id: The ID of the tenant to update. (required) + :type tenant_id: str + :param admin_update_tenant_model: (required) + :type admin_update_tenant_model: AdminUpdateTenantModel + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_tenant_serialize( + tenant_id=tenant_id, + admin_update_tenant_model=admin_update_tenant_model, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantProvisionAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_tenant_serialize( + self, + tenant_id, + admin_update_tenant_model, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if admin_update_tenant_model is not None: + _body_params = admin_update_tenant_model + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/tenants/{tenantId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def validate_tenant( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DpAutomationTenantPreviewEntriesSummaryDTO: + """Validate an analytic tenant's metric values + + Retrieve the metric values for an individual analytic tenant. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home button**. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_tenant_serialize( + tenant_id=tenant_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DpAutomationTenantPreviewEntriesSummaryDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def validate_tenant_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DpAutomationTenantPreviewEntriesSummaryDTO]: + """Validate an analytic tenant's metric values + + Retrieve the metric values for an individual analytic tenant. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home button**. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_tenant_serialize( + tenant_id=tenant_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DpAutomationTenantPreviewEntriesSummaryDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def validate_tenant_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Validate an analytic tenant's metric values + + Retrieve the metric values for an individual analytic tenant. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home button**. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_tenant_serialize( + tenant_id=tenant_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DpAutomationTenantPreviewEntriesSummaryDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _validate_tenant_serialize( + self, + tenant_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/validation/tenants/{tenantId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def validate_tenants( + self, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DpAutomationTenantPreviewEntriesSummaryListDTO: + """Validate metric values for all analytic tenants + + As you onboard more analytic tenants, you can validate the data visible to your users to ensure it matches the source systems from which it was exported and that it matches what your expectations are for this data. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home** button. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production. + + :param limit: The limit of analytic tenant details to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_tenants_serialize( + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DpAutomationTenantPreviewEntriesSummaryListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def validate_tenants_with_http_info( + self, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DpAutomationTenantPreviewEntriesSummaryListDTO]: + """Validate metric values for all analytic tenants + + As you onboard more analytic tenants, you can validate the data visible to your users to ensure it matches the source systems from which it was exported and that it matches what your expectations are for this data. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home** button. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production. + + :param limit: The limit of analytic tenant details to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_tenants_serialize( + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DpAutomationTenantPreviewEntriesSummaryListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def validate_tenants_without_preload_content( + self, + limit: Annotated[Optional[StrictInt], Field(description="The limit of analytic tenant details to retrieve.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Validate metric values for all analytic tenants + + As you onboard more analytic tenants, you can validate the data visible to your users to ensure it matches the source systems from which it was exported and that it matches what your expectations are for this data. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the **Home** button. - Click **Dashboard**, and then click **Edit Summary Metrics**. - Select the metrics that you want to validate, and then close the **Summary Metrics** dialog. - Publish the project to production. + + :param limit: The limit of analytic tenant details to retrieve. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._validate_tenants_serialize( + limit=limit, + start=start, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DpAutomationTenantPreviewEntriesSummaryListDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _validate_tenants_serialize( + self, + limit, + start, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/op/validation/tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/tenants_v2_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/tenants_v2_api.py new file mode 100644 index 0000000000..ffc4a8f687 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/tenants_v2_api.py @@ -0,0 +1,1595 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_mask_message import AdminMaskMessage +from visier_platform_sdk.models.admin_tenant_management_api_get_response_dto import AdminTenantManagementAPIGetResponseDTO +from visier_platform_sdk.models.admin_tenant_management_api_list_response_dto import AdminTenantManagementAPIListResponseDTO +from visier_platform_sdk.models.admin_tenant_management_api_update_request_dto import AdminTenantManagementAPIUpdateRequestDTO +from visier_platform_sdk.models.admin_tenant_management_api_update_response_dto import AdminTenantManagementAPIUpdateResponseDTO +from visier_platform_sdk.models.admin_tenant_status_apidto import AdminTenantStatusAPIDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class TenantsV2Api: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def create_tenant( + self, + admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantManagementAPIUpdateResponseDTO: + """Add an analytic tenant + + Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you. **Note:** API requests that contain `homeAnalysisId`, `homeAnalysisByUserGroup`, `clickThroughLink`, or `defaultCurrency` take longer to run because they require publishing a project to production. + + :param admin_tenant_management_api_update_request_dto: (required) + :type admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tenant_serialize( + admin_tenant_management_api_update_request_dto=admin_tenant_management_api_update_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_tenant_with_http_info( + self, + admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantManagementAPIUpdateResponseDTO]: + """Add an analytic tenant + + Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you. **Note:** API requests that contain `homeAnalysisId`, `homeAnalysisByUserGroup`, `clickThroughLink`, or `defaultCurrency` take longer to run because they require publishing a project to production. + + :param admin_tenant_management_api_update_request_dto: (required) + :type admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tenant_serialize( + admin_tenant_management_api_update_request_dto=admin_tenant_management_api_update_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_tenant_without_preload_content( + self, + admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add an analytic tenant + + Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. Create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you. **Note:** API requests that contain `homeAnalysisId`, `homeAnalysisByUserGroup`, `clickThroughLink`, or `defaultCurrency` take longer to run because they require publishing a project to production. + + :param admin_tenant_management_api_update_request_dto: (required) + :type admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_tenant_serialize( + admin_tenant_management_api_update_request_dto=admin_tenant_management_api_update_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_tenant_serialize( + self, + admin_tenant_management_api_update_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_tenant_management_api_update_request_dto is not None: + _body_params = admin_tenant_management_api_update_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v2/admin/tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_tenant( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantStatusAPIDTO: + """Deprovision an analytic tenant + + Warning! Deprovisioning an analytic tenant is not reversible. Before deprovisioning, you must disable an analytic tenant. For more information, see **`/v1/admin/tenants/{tenantId}/disable`**. This API removes an analytic tenant permanently from the Visier system. If you are unsure whether an analytic tenant may be re-enabled on any of the Visier modules at any time, you may instead want to disable the analytic tenant. If successful, the response returns the status \"Deprovisioned\". This indicates that the tenant is scheduled for deprovisioning, which may take several days to complete. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_tenant_serialize( + tenant_id=tenant_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_tenant_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantStatusAPIDTO]: + """Deprovision an analytic tenant + + Warning! Deprovisioning an analytic tenant is not reversible. Before deprovisioning, you must disable an analytic tenant. For more information, see **`/v1/admin/tenants/{tenantId}/disable`**. This API removes an analytic tenant permanently from the Visier system. If you are unsure whether an analytic tenant may be re-enabled on any of the Visier modules at any time, you may instead want to disable the analytic tenant. If successful, the response returns the status \"Deprovisioned\". This indicates that the tenant is scheduled for deprovisioning, which may take several days to complete. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_tenant_serialize( + tenant_id=tenant_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_tenant_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.")], + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Deprovision an analytic tenant + + Warning! Deprovisioning an analytic tenant is not reversible. Before deprovisioning, you must disable an analytic tenant. For more information, see **`/v1/admin/tenants/{tenantId}/disable`**. This API removes an analytic tenant permanently from the Visier system. If you are unsure whether an analytic tenant may be re-enabled on any of the Visier modules at any time, you may instead want to disable the analytic tenant. If successful, the response returns the status \"Deprovisioned\". This indicates that the tenant is scheduled for deprovisioning, which may take several days to complete. + + :param tenant_id: The ID of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code. (required) + :type tenant_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_tenant_serialize( + tenant_id=tenant_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantStatusAPIDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_tenant_serialize( + self, + tenant_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v2/admin/tenants/{tenantId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def list_tenants( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of tenants to return. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first tenant to return. Default is 0.")] = None, + mask: Annotated[Optional[StrictStr], Field(description="A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\"")] = None, + 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, + admin_mask_message: Optional[AdminMaskMessage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantManagementAPIListResponseDTO: + """Retrieve a list of all analytic tenants + + Retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested. + + :param limit: The maximum number of tenants to return. Default is 400. + :type limit: int + :param start: The starting index of the first tenant to return. Default is 0. + :type start: int + :param mask: A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\" + :type mask: str + :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. + :type target_tenant_id: str + :param admin_mask_message: + :type admin_mask_message: AdminMaskMessage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_tenants_serialize( + limit=limit, + start=start, + mask=mask, + target_tenant_id=target_tenant_id, + admin_mask_message=admin_mask_message, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def list_tenants_with_http_info( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of tenants to return. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first tenant to return. Default is 0.")] = None, + mask: Annotated[Optional[StrictStr], Field(description="A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\"")] = None, + 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, + admin_mask_message: Optional[AdminMaskMessage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantManagementAPIListResponseDTO]: + """Retrieve a list of all analytic tenants + + Retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested. + + :param limit: The maximum number of tenants to return. Default is 400. + :type limit: int + :param start: The starting index of the first tenant to return. Default is 0. + :type start: int + :param mask: A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\" + :type mask: str + :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. + :type target_tenant_id: str + :param admin_mask_message: + :type admin_mask_message: AdminMaskMessage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_tenants_serialize( + limit=limit, + start=start, + mask=mask, + target_tenant_id=target_tenant_id, + admin_mask_message=admin_mask_message, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def list_tenants_without_preload_content( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of tenants to return. Default is 400.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The starting index of the first tenant to return. Default is 0.")] = None, + mask: Annotated[Optional[StrictStr], Field(description="A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\"")] = None, + 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, + admin_mask_message: Optional[AdminMaskMessage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all analytic tenants + + Retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested. + + :param limit: The maximum number of tenants to return. Default is 400. + :type limit: int + :param start: The starting index of the first tenant to return. Default is 0. + :type start: int + :param mask: A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\" + :type mask: str + :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. + :type target_tenant_id: str + :param admin_mask_message: + :type admin_mask_message: AdminMaskMessage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_tenants_serialize( + limit=limit, + start=start, + mask=mask, + target_tenant_id=target_tenant_id, + admin_mask_message=admin_mask_message, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIListResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _list_tenants_serialize( + self, + limit, + start, + mask, + target_tenant_id, + admin_mask_message, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + if mask is not None: + + _query_params.append(('mask', mask)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_mask_message is not None: + _body_params = admin_mask_message + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v2/admin/tenants', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def tenant_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to retrieve.")], + mask: Annotated[Optional[StrictStr], Field(description="A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\"")] = None, + 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, + admin_mask_message: Optional[AdminMaskMessage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantManagementAPIGetResponseDTO: + """Retrieve an analytic tenant's details + + Retrieve the details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant. + + :param tenant_id: The ID of the tenant to retrieve. (required) + :type tenant_id: str + :param mask: A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\" + :type mask: str + :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. + :type target_tenant_id: str + :param admin_mask_message: + :type admin_mask_message: AdminMaskMessage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._tenant_info_serialize( + tenant_id=tenant_id, + mask=mask, + target_tenant_id=target_tenant_id, + admin_mask_message=admin_mask_message, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIGetResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def tenant_info_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to retrieve.")], + mask: Annotated[Optional[StrictStr], Field(description="A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\"")] = None, + 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, + admin_mask_message: Optional[AdminMaskMessage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantManagementAPIGetResponseDTO]: + """Retrieve an analytic tenant's details + + Retrieve the details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant. + + :param tenant_id: The ID of the tenant to retrieve. (required) + :type tenant_id: str + :param mask: A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\" + :type mask: str + :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. + :type target_tenant_id: str + :param admin_mask_message: + :type admin_mask_message: AdminMaskMessage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._tenant_info_serialize( + tenant_id=tenant_id, + mask=mask, + target_tenant_id=target_tenant_id, + admin_mask_message=admin_mask_message, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIGetResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def tenant_info_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to retrieve.")], + mask: Annotated[Optional[StrictStr], Field(description="A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\"")] = None, + 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, + admin_mask_message: Optional[AdminMaskMessage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an analytic tenant's details + + Retrieve the details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant. + + :param tenant_id: The ID of the tenant to retrieve. (required) + :type tenant_id: str + :param mask: A list of fields to include in the response, separated by commas. E.g., \"displayName,purchasedModules\" + :type mask: str + :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. + :type target_tenant_id: str + :param admin_mask_message: + :type admin_mask_message: AdminMaskMessage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._tenant_info_serialize( + tenant_id=tenant_id, + mask=mask, + target_tenant_id=target_tenant_id, + admin_mask_message=admin_mask_message, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIGetResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _tenant_info_serialize( + self, + tenant_id, + mask, + target_tenant_id, + admin_mask_message, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + if mask is not None: + + _query_params.append(('mask', mask)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_mask_message is not None: + _body_params = admin_mask_message + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v2/admin/tenants/{tenantId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_tenant( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to update.")], + admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminTenantManagementAPIUpdateResponseDTO: + """Update an analytic tenant + + You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To make updates to your tenants, use this API. * To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. * To programmatically assign the Home analysis that analytic tenants see at login, use this API to set the default Home analysis for a tenant and specific user groups of that tenant. You can use this API to update any field on an analytic tenant, except `tenantCode`. **Note:** API requests that contain `homeAnalysisId`, `homeAnalysisByUserGroup`, `clickThroughLink`, or `defaultCurrency` take longer to run because they require publishing a project to production. + + :param tenant_id: The ID of the tenant to update. (required) + :type tenant_id: str + :param admin_tenant_management_api_update_request_dto: (required) + :type admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_tenant_serialize( + tenant_id=tenant_id, + admin_tenant_management_api_update_request_dto=admin_tenant_management_api_update_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_tenant_with_http_info( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to update.")], + admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminTenantManagementAPIUpdateResponseDTO]: + """Update an analytic tenant + + You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To make updates to your tenants, use this API. * To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. * To programmatically assign the Home analysis that analytic tenants see at login, use this API to set the default Home analysis for a tenant and specific user groups of that tenant. You can use this API to update any field on an analytic tenant, except `tenantCode`. **Note:** API requests that contain `homeAnalysisId`, `homeAnalysisByUserGroup`, `clickThroughLink`, or `defaultCurrency` take longer to run because they require publishing a project to production. + + :param tenant_id: The ID of the tenant to update. (required) + :type tenant_id: str + :param admin_tenant_management_api_update_request_dto: (required) + :type admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_tenant_serialize( + tenant_id=tenant_id, + admin_tenant_management_api_update_request_dto=admin_tenant_management_api_update_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_tenant_without_preload_content( + self, + tenant_id: Annotated[StrictStr, Field(description="The ID of the tenant to update.")], + admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update an analytic tenant + + You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To make updates to your tenants, use this API. * To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. * To programmatically assign the Home analysis that analytic tenants see at login, use this API to set the default Home analysis for a tenant and specific user groups of that tenant. You can use this API to update any field on an analytic tenant, except `tenantCode`. **Note:** API requests that contain `homeAnalysisId`, `homeAnalysisByUserGroup`, `clickThroughLink`, or `defaultCurrency` take longer to run because they require publishing a project to production. + + :param tenant_id: The ID of the tenant to update. (required) + :type tenant_id: str + :param admin_tenant_management_api_update_request_dto: (required) + :type admin_tenant_management_api_update_request_dto: AdminTenantManagementAPIUpdateRequestDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_tenant_serialize( + tenant_id=tenant_id, + admin_tenant_management_api_update_request_dto=admin_tenant_management_api_update_request_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminTenantManagementAPIUpdateResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_tenant_serialize( + self, + tenant_id, + admin_tenant_management_api_update_request_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if tenant_id is not None: + _path_params['tenantId'] = tenant_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_tenant_management_api_update_request_dto is not None: + _body_params = admin_tenant_management_api_update_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v2/admin/tenants/{tenantId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/user_groups_v2_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/user_groups_v2_api.py new file mode 100644 index 0000000000..f097e77a3f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/user_groups_v2_api.py @@ -0,0 +1,2332 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_delete_user_group_v2_request import AdminDeleteUserGroupV2Request +from visier_platform_sdk.models.admin_user_group_change_definition_dto import AdminUserGroupChangeDefinitionDTO +from visier_platform_sdk.models.admin_user_group_change_response_dto import AdminUserGroupChangeResponseDTO +from visier_platform_sdk.models.admin_user_group_delete_response_dto import AdminUserGroupDeleteResponseDTO +from visier_platform_sdk.models.admin_user_group_single_delete_response_dto import AdminUserGroupSingleDeleteResponseDTO +from visier_platform_sdk.models.admin_user_groups_change_dto import AdminUserGroupsChangeDTO +from visier_platform_sdk.models.admin_user_groups_delete_request_dto import AdminUserGroupsDeleteRequestDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class UserGroupsV2Api: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def create_user_groups( + self, + admin_user_groups_change_dto: AdminUserGroupsChangeDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminUserGroupChangeResponseDTO: + """Create multiple user groups + + Create new user groups. To specify the tenant in which to add new user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to create new user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_change_dto: (required) + :type admin_user_groups_change_dto: AdminUserGroupsChangeDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_user_groups_serialize( + admin_user_groups_change_dto=admin_user_groups_change_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_user_groups_with_http_info( + self, + admin_user_groups_change_dto: AdminUserGroupsChangeDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminUserGroupChangeResponseDTO]: + """Create multiple user groups + + Create new user groups. To specify the tenant in which to add new user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to create new user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_change_dto: (required) + :type admin_user_groups_change_dto: AdminUserGroupsChangeDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_user_groups_serialize( + admin_user_groups_change_dto=admin_user_groups_change_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_user_groups_without_preload_content( + self, + admin_user_groups_change_dto: AdminUserGroupsChangeDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create multiple user groups + + Create new user groups. To specify the tenant in which to add new user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to create new user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_change_dto: (required) + :type admin_user_groups_change_dto: AdminUserGroupsChangeDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_user_groups_serialize( + admin_user_groups_change_dto=admin_user_groups_change_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_user_groups_serialize( + self, + admin_user_groups_change_dto, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if admin_user_groups_change_dto is not None: + _body_params = admin_user_groups_change_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v2/admin/user-groups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_user_group( + self, + user_group_id: Annotated[StrictStr, Field(description="The ID of user group to delete.")], + admin_delete_user_group_v2_request: AdminDeleteUserGroupV2Request, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminUserGroupSingleDeleteResponseDTO: + """Delete a user group + + Delete a specific user group. To specify the tenant in which to delete a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to delete a user group, provide a project UUID in the `ProjectID` request header. + + :param user_group_id: The ID of user group to delete. (required) + :type user_group_id: str + :param admin_delete_user_group_v2_request: (required) + :type admin_delete_user_group_v2_request: AdminDeleteUserGroupV2Request + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_user_group_serialize( + user_group_id=user_group_id, + admin_delete_user_group_v2_request=admin_delete_user_group_v2_request, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupSingleDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_user_group_with_http_info( + self, + user_group_id: Annotated[StrictStr, Field(description="The ID of user group to delete.")], + admin_delete_user_group_v2_request: AdminDeleteUserGroupV2Request, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminUserGroupSingleDeleteResponseDTO]: + """Delete a user group + + Delete a specific user group. To specify the tenant in which to delete a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to delete a user group, provide a project UUID in the `ProjectID` request header. + + :param user_group_id: The ID of user group to delete. (required) + :type user_group_id: str + :param admin_delete_user_group_v2_request: (required) + :type admin_delete_user_group_v2_request: AdminDeleteUserGroupV2Request + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_user_group_serialize( + user_group_id=user_group_id, + admin_delete_user_group_v2_request=admin_delete_user_group_v2_request, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupSingleDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_user_group_without_preload_content( + self, + user_group_id: Annotated[StrictStr, Field(description="The ID of user group to delete.")], + admin_delete_user_group_v2_request: AdminDeleteUserGroupV2Request, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a user group + + Delete a specific user group. To specify the tenant in which to delete a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to delete a user group, provide a project UUID in the `ProjectID` request header. + + :param user_group_id: The ID of user group to delete. (required) + :type user_group_id: str + :param admin_delete_user_group_v2_request: (required) + :type admin_delete_user_group_v2_request: AdminDeleteUserGroupV2Request + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_user_group_serialize( + user_group_id=user_group_id, + admin_delete_user_group_v2_request=admin_delete_user_group_v2_request, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupSingleDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_user_group_serialize( + self, + user_group_id, + admin_delete_user_group_v2_request, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if admin_delete_user_group_v2_request is not None: + _body_params = admin_delete_user_group_v2_request + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v2/admin/user-groups/{userGroupId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_user_groups( + self, + admin_user_groups_delete_request_dto: AdminUserGroupsDeleteRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminUserGroupDeleteResponseDTO: + """Delete multiple user groups + + Delete user groups in bulk. To specify the tenant in which to delete user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to delete user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_delete_request_dto: (required) + :type admin_user_groups_delete_request_dto: AdminUserGroupsDeleteRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_user_groups_serialize( + admin_user_groups_delete_request_dto=admin_user_groups_delete_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_user_groups_with_http_info( + self, + admin_user_groups_delete_request_dto: AdminUserGroupsDeleteRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminUserGroupDeleteResponseDTO]: + """Delete multiple user groups + + Delete user groups in bulk. To specify the tenant in which to delete user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to delete user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_delete_request_dto: (required) + :type admin_user_groups_delete_request_dto: AdminUserGroupsDeleteRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_user_groups_serialize( + admin_user_groups_delete_request_dto=admin_user_groups_delete_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_user_groups_without_preload_content( + self, + admin_user_groups_delete_request_dto: AdminUserGroupsDeleteRequestDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete multiple user groups + + Delete user groups in bulk. To specify the tenant in which to delete user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to delete user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_delete_request_dto: (required) + :type admin_user_groups_delete_request_dto: AdminUserGroupsDeleteRequestDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_user_groups_serialize( + admin_user_groups_delete_request_dto=admin_user_groups_delete_request_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupDeleteResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_user_groups_serialize( + self, + admin_user_groups_delete_request_dto, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if admin_user_groups_delete_request_dto is not None: + _body_params = admin_user_groups_delete_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v2/admin/user-groups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_user_group( + self, + user_group_id: Annotated[StrictStr, Field(description="The ID of user group.")], + var_with: Annotated[Optional[StrictStr], Field(description="Controls the amount of detail to return in the response. Omit to return detailed information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminUserGroupChangeDefinitionDTO: + """Retrieve the details of a user group + + Retrieve all available information about a specific user group.
To specify the tenant in which to retrieve a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to return a user group, provide a project UUID in the `ProjectID` request header. + + :param user_group_id: The ID of user group. (required) + :type user_group_id: str + :param var_with: Controls the amount of detail to return in the response. Omit to return detailed information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information. + :type var_with: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_serialize( + user_group_id=user_group_id, + var_with=var_with, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeDefinitionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_group_with_http_info( + self, + user_group_id: Annotated[StrictStr, Field(description="The ID of user group.")], + var_with: Annotated[Optional[StrictStr], Field(description="Controls the amount of detail to return in the response. Omit to return detailed information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminUserGroupChangeDefinitionDTO]: + """Retrieve the details of a user group + + Retrieve all available information about a specific user group.
To specify the tenant in which to retrieve a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to return a user group, provide a project UUID in the `ProjectID` request header. + + :param user_group_id: The ID of user group. (required) + :type user_group_id: str + :param var_with: Controls the amount of detail to return in the response. Omit to return detailed information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information. + :type var_with: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_serialize( + user_group_id=user_group_id, + var_with=var_with, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeDefinitionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_group_without_preload_content( + self, + user_group_id: Annotated[StrictStr, Field(description="The ID of user group.")], + var_with: Annotated[Optional[StrictStr], Field(description="Controls the amount of detail to return in the response. Omit to return detailed information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the details of a user group + + Retrieve all available information about a specific user group.
To specify the tenant in which to retrieve a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. To specify the project in which to return a user group, provide a project UUID in the `ProjectID` request header. + + :param user_group_id: The ID of user group. (required) + :type user_group_id: str + :param var_with: Controls the amount of detail to return in the response. Omit to return detailed information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information. + :type var_with: str + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_serialize( + user_group_id=user_group_id, + var_with=var_with, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeDefinitionDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_group_serialize( + self, + user_group_id, + var_with, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + if var_with is not None: + + _query_params.append(('with', var_with)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v2/admin/user-groups/{userGroupId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_user_groups( + self, + var_with: Annotated[Optional[StrictStr], Field(description="Controls the amount of detail to return in the response. Omit to return basic information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of user groups to retrieve is 1000. The default is 100.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminUserGroupsChangeDTO: + """Retrieve a list of user groups + + Retrieve a collection of user groups. Use `with` to control the amount of detail returned in the response. `with` supports these values: * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information. This API can return a maximum of 1000 user groups. The default number of user groups to return is 100. To specify the project in which to return user groups, provide a project UUID in the `ProjectID` request header.
To specify the tenant in which to retrieve user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. + + :param var_with: Controls the amount of detail to return in the response. Omit to return basic information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information. + :type var_with: str + :param limit: The number of results to return. The maximum number of user groups to retrieve is 1000. The default is 100. + :type limit: int + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_groups_serialize( + var_with=var_with, + limit=limit, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupsChangeDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_groups_with_http_info( + self, + var_with: Annotated[Optional[StrictStr], Field(description="Controls the amount of detail to return in the response. Omit to return basic information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of user groups to retrieve is 1000. The default is 100.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminUserGroupsChangeDTO]: + """Retrieve a list of user groups + + Retrieve a collection of user groups. Use `with` to control the amount of detail returned in the response. `with` supports these values: * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information. This API can return a maximum of 1000 user groups. The default number of user groups to return is 100. To specify the project in which to return user groups, provide a project UUID in the `ProjectID` request header.
To specify the tenant in which to retrieve user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. + + :param var_with: Controls the amount of detail to return in the response. Omit to return basic information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information. + :type var_with: str + :param limit: The number of results to return. The maximum number of user groups to retrieve is 1000. The default is 100. + :type limit: int + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_groups_serialize( + var_with=var_with, + limit=limit, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupsChangeDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_groups_without_preload_content( + self, + var_with: Annotated[Optional[StrictStr], Field(description="Controls the amount of detail to return in the response. Omit to return basic information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of user groups to retrieve is 1000. The default is 100.")] = None, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of user groups + + Retrieve a collection of user groups. Use `with` to control the amount of detail returned in the response. `with` supports these values: * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information. This API can return a maximum of 1000 user groups. The default number of user groups to return is 100. To specify the project in which to return user groups, provide a project UUID in the `ProjectID` request header.
To specify the tenant in which to retrieve user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header. + + :param var_with: Controls the amount of detail to return in the response. Omit to return basic information. * **permissions**: Include the user group's permissions. * **users**: Include the users in the user group. * **details**: Include all available information. + :type var_with: str + :param limit: The number of results to return. The maximum number of user groups to retrieve is 1000. The default is 100. + :type limit: int + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_groups_serialize( + var_with=var_with, + limit=limit, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupsChangeDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_groups_serialize( + self, + var_with, + limit, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if var_with is not None: + + _query_params.append(('with', var_with)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v2/admin/user-groups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def patch_user_groups( + self, + admin_user_groups_change_dto: AdminUserGroupsChangeDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminUserGroupChangeResponseDTO: + """Patch multiple user groups + + Make partial changes to user groups. To specify the tenant in which to patch a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each user group in the request body. Unlike `PUT`, which completely replaces the user group definition, use `PATCH` to change specific fields in the user group without affecting omitted fields. To specify the project in which to patch user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_change_dto: (required) + :type admin_user_groups_change_dto: AdminUserGroupsChangeDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_user_groups_serialize( + admin_user_groups_change_dto=admin_user_groups_change_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def patch_user_groups_with_http_info( + self, + admin_user_groups_change_dto: AdminUserGroupsChangeDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminUserGroupChangeResponseDTO]: + """Patch multiple user groups + + Make partial changes to user groups. To specify the tenant in which to patch a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each user group in the request body. Unlike `PUT`, which completely replaces the user group definition, use `PATCH` to change specific fields in the user group without affecting omitted fields. To specify the project in which to patch user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_change_dto: (required) + :type admin_user_groups_change_dto: AdminUserGroupsChangeDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_user_groups_serialize( + admin_user_groups_change_dto=admin_user_groups_change_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def patch_user_groups_without_preload_content( + self, + admin_user_groups_change_dto: AdminUserGroupsChangeDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch multiple user groups + + Make partial changes to user groups. To specify the tenant in which to patch a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each user group in the request body. Unlike `PUT`, which completely replaces the user group definition, use `PATCH` to change specific fields in the user group without affecting omitted fields. To specify the project in which to patch user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_change_dto: (required) + :type admin_user_groups_change_dto: AdminUserGroupsChangeDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._patch_user_groups_serialize( + admin_user_groups_change_dto=admin_user_groups_change_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _patch_user_groups_serialize( + self, + admin_user_groups_change_dto, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if admin_user_groups_change_dto is not None: + _body_params = admin_user_groups_change_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/v2/admin/user-groups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def put_user_groups( + self, + admin_user_groups_change_dto: AdminUserGroupsChangeDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminUserGroupChangeResponseDTO: + """Update multiple user groups + + Update existing user groups. To specify the tenant in which to update a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each user group in the request body. When updating user groups, the user group definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the user group. We recommend that you retrieve a user group's details before you update the user group with new values. To specify the project in which to update user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_change_dto: (required) + :type admin_user_groups_change_dto: AdminUserGroupsChangeDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_user_groups_serialize( + admin_user_groups_change_dto=admin_user_groups_change_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def put_user_groups_with_http_info( + self, + admin_user_groups_change_dto: AdminUserGroupsChangeDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminUserGroupChangeResponseDTO]: + """Update multiple user groups + + Update existing user groups. To specify the tenant in which to update a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each user group in the request body. When updating user groups, the user group definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the user group. We recommend that you retrieve a user group's details before you update the user group with new values. To specify the project in which to update user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_change_dto: (required) + :type admin_user_groups_change_dto: AdminUserGroupsChangeDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_user_groups_serialize( + admin_user_groups_change_dto=admin_user_groups_change_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def put_user_groups_without_preload_content( + self, + admin_user_groups_change_dto: AdminUserGroupsChangeDTO, + 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, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request.")] = None, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update multiple user groups + + Update existing user groups. To specify the tenant in which to update a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each user group in the request body. When updating user groups, the user group definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the user group. We recommend that you retrieve a user group's details before you update the user group with new values. To specify the project in which to update user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body. + + :param admin_user_groups_change_dto: (required) + :type admin_user_groups_change_dto: AdminUserGroupsChangeDTO + :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. + :type target_tenant_id: str + :param project_id: Optionally, specify a project in which to make the request. + :type project_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._put_user_groups_serialize( + admin_user_groups_change_dto=admin_user_groups_change_dto, + target_tenant_id=target_tenant_id, + project_id=project_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupChangeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _put_user_groups_serialize( + self, + admin_user_groups_change_dto, + target_tenant_id, + project_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if project_id is not None: + _header_params['ProjectID'] = project_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if admin_user_groups_change_dto is not None: + _body_params = admin_user_groups_change_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v2/admin/user-groups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/users_v1_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/users_v1_api.py new file mode 100644 index 0000000000..9985a3712e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/users_v1_api.py @@ -0,0 +1,6157 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictBytes, StrictInt, StrictStr +from typing import Any, Dict, Optional, Tuple, Union +from typing_extensions import Annotated +from visier_platform_sdk.models.admin_permissions_to_user_group_for_tenant_dto import AdminPermissionsToUserGroupForTenantDTO +from visier_platform_sdk.models.admin_permissions_to_user_groups_request_dto import AdminPermissionsToUserGroupsRequestDTO +from visier_platform_sdk.models.admin_security_assignment_response_dto import AdminSecurityAssignmentResponseDTO +from visier_platform_sdk.models.admin_user_groups_get_api_response_dto import AdminUserGroupsGetAPIResponseDTO +from visier_platform_sdk.models.admin_user_groups_users_dto import AdminUserGroupsUsersDTO +from visier_platform_sdk.models.admin_users_to_user_groups_request_dto import AdminUsersToUserGroupsRequestDTO +from visier_platform_sdk.models.servicing_all_users_get_api_response_dto import ServicingAllUsersGetAPIResponseDTO +from visier_platform_sdk.models.servicing_assign_revoke_permissions_request_dto import ServicingAssignRevokePermissionsRequestDTO +from visier_platform_sdk.models.servicing_assign_revoke_permissions_response_dto import ServicingAssignRevokePermissionsResponseDTO +from visier_platform_sdk.models.servicing_permission_assigned_users_dto import ServicingPermissionAssignedUsersDTO +from visier_platform_sdk.models.servicing_user_creation_api_request_dto import ServicingUserCreationAPIRequestDTO +from visier_platform_sdk.models.servicing_user_get_api_response_dto import ServicingUserGetAPIResponseDTO +from visier_platform_sdk.models.servicing_user_update_api_request_dto import ServicingUserUpdateAPIRequestDTO +from visier_platform_sdk.models.user_creation_api_response_dto import UserCreationAPIResponseDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class UsersV1Api: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def add_user( + self, + servicing_user_creation_api_request_dto: ServicingUserCreationAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserCreationAPIResponseDTO: + """Add a user + + Create a new user. Administrating tenant users can specify the tenant in which to add a user. + + :param servicing_user_creation_api_request_dto: (required) + :type servicing_user_creation_api_request_dto: ServicingUserCreationAPIRequestDTO + :param tenant_code: Specify the tenant to create a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_user_serialize( + servicing_user_creation_api_request_dto=servicing_user_creation_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "UserCreationAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def add_user_with_http_info( + self, + servicing_user_creation_api_request_dto: ServicingUserCreationAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserCreationAPIResponseDTO]: + """Add a user + + Create a new user. Administrating tenant users can specify the tenant in which to add a user. + + :param servicing_user_creation_api_request_dto: (required) + :type servicing_user_creation_api_request_dto: ServicingUserCreationAPIRequestDTO + :param tenant_code: Specify the tenant to create a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_user_serialize( + servicing_user_creation_api_request_dto=servicing_user_creation_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "UserCreationAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def add_user_without_preload_content( + self, + servicing_user_creation_api_request_dto: ServicingUserCreationAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add a user + + Create a new user. Administrating tenant users can specify the tenant in which to add a user. + + :param servicing_user_creation_api_request_dto: (required) + :type servicing_user_creation_api_request_dto: ServicingUserCreationAPIRequestDTO + :param tenant_code: Specify the tenant to create a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_user_serialize( + servicing_user_creation_api_request_dto=servicing_user_creation_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "UserCreationAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _add_user_serialize( + self, + servicing_user_creation_api_request_dto, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_user_creation_api_request_dto is not None: + _body_params = servicing_user_creation_api_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1/admin/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def add_users_to_user_group( + self, + admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminSecurityAssignmentResponseDTO: + """Assign users to user groups + + This API allows you to assign users to specific user groups. To assign users to user groups in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can assign users to user groups in multiple analytic tenants by providing a tenant code and project ID in the request body. We recommend that administrating tenants set the analytic tenant in which to execute the API call using the `TargetTenantID` request header. + + :param admin_users_to_user_groups_request_dto: (required) + :type admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_users_to_user_group_serialize( + admin_users_to_user_groups_request_dto=admin_users_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminSecurityAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def add_users_to_user_group_with_http_info( + self, + admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminSecurityAssignmentResponseDTO]: + """Assign users to user groups + + This API allows you to assign users to specific user groups. To assign users to user groups in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can assign users to user groups in multiple analytic tenants by providing a tenant code and project ID in the request body. We recommend that administrating tenants set the analytic tenant in which to execute the API call using the `TargetTenantID` request header. + + :param admin_users_to_user_groups_request_dto: (required) + :type admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_users_to_user_group_serialize( + admin_users_to_user_groups_request_dto=admin_users_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminSecurityAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def add_users_to_user_group_without_preload_content( + self, + admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Assign users to user groups + + This API allows you to assign users to specific user groups. To assign users to user groups in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can assign users to user groups in multiple analytic tenants by providing a tenant code and project ID in the request body. We recommend that administrating tenants set the analytic tenant in which to execute the API call using the `TargetTenantID` request header. + + :param admin_users_to_user_groups_request_dto: (required) + :type admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_users_to_user_group_serialize( + admin_users_to_user_groups_request_dto=admin_users_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminSecurityAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _add_users_to_user_group_serialize( + self, + admin_users_to_user_groups_request_dto, + project_id, + target_tenant_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if admin_users_to_user_groups_request_dto is not None: + _body_params = admin_users_to_user_groups_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/user-groups/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def assign_permissions( + self, + servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingAssignRevokePermissionsResponseDTO: + """Assign permissions to users + + This API allows you to assign a permission to specific users. Administrating tenant users can assign permissions to users in the administrating tenant and in the analytic tenants those users belong to. To assign permissions to users in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can assign permissions to users in analytic tenants by providing a tenant code and project ID in the request body. + + :param servicing_assign_revoke_permissions_request_dto: (required) + :type servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_permissions_serialize( + servicing_assign_revoke_permissions_request_dto=servicing_assign_revoke_permissions_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAssignRevokePermissionsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def assign_permissions_with_http_info( + self, + servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingAssignRevokePermissionsResponseDTO]: + """Assign permissions to users + + This API allows you to assign a permission to specific users. Administrating tenant users can assign permissions to users in the administrating tenant and in the analytic tenants those users belong to. To assign permissions to users in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can assign permissions to users in analytic tenants by providing a tenant code and project ID in the request body. + + :param servicing_assign_revoke_permissions_request_dto: (required) + :type servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_permissions_serialize( + servicing_assign_revoke_permissions_request_dto=servicing_assign_revoke_permissions_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAssignRevokePermissionsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def assign_permissions_without_preload_content( + self, + servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Assign permissions to users + + This API allows you to assign a permission to specific users. Administrating tenant users can assign permissions to users in the administrating tenant and in the analytic tenants those users belong to. To assign permissions to users in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can assign permissions to users in analytic tenants by providing a tenant code and project ID in the request body. + + :param servicing_assign_revoke_permissions_request_dto: (required) + :type servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_permissions_serialize( + servicing_assign_revoke_permissions_request_dto=servicing_assign_revoke_permissions_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAssignRevokePermissionsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _assign_permissions_serialize( + self, + servicing_assign_revoke_permissions_request_dto, + project_id, + target_tenant_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if servicing_assign_revoke_permissions_request_dto is not None: + _body_params = servicing_assign_revoke_permissions_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/permissions/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def assign_permissions_to_user_groups( + self, + admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminPermissionsToUserGroupForTenantDTO: + """Assign permissions to user groups + + This API allows you to assign a permission to specific user groups. This assigns the permission to all users in the user group. To assign permissions to user groups in a project, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_to_user_groups_request_dto: (required) + :type admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_permissions_to_user_groups_serialize( + admin_permissions_to_user_groups_request_dto=admin_permissions_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminPermissionsToUserGroupForTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def assign_permissions_to_user_groups_with_http_info( + self, + admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminPermissionsToUserGroupForTenantDTO]: + """Assign permissions to user groups + + This API allows you to assign a permission to specific user groups. This assigns the permission to all users in the user group. To assign permissions to user groups in a project, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_to_user_groups_request_dto: (required) + :type admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_permissions_to_user_groups_serialize( + admin_permissions_to_user_groups_request_dto=admin_permissions_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminPermissionsToUserGroupForTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def assign_permissions_to_user_groups_without_preload_content( + self, + admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Assign permissions to user groups + + This API allows you to assign a permission to specific user groups. This assigns the permission to all users in the user group. To assign permissions to user groups in a project, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_to_user_groups_request_dto: (required) + :type admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._assign_permissions_to_user_groups_serialize( + admin_permissions_to_user_groups_request_dto=admin_permissions_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminPermissionsToUserGroupForTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _assign_permissions_to_user_groups_serialize( + self, + admin_permissions_to_user_groups_request_dto, + project_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_permissions_to_user_groups_request_dto is not None: + _body_params = admin_permissions_to_user_groups_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/user-groups/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_user( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to delete.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> object: + """Delete a user + + Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user. + + :param user_id: The ID of the user you want to delete. (required) + :type user_id: str + :param tenant_code: Specify the tenant to delete a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_user_serialize( + user_id=user_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_user_with_http_info( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to delete.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[object]: + """Delete a user + + Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user. + + :param user_id: The ID of the user you want to delete. (required) + :type user_id: str + :param tenant_code: Specify the tenant to delete a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_user_serialize( + user_id=user_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_user_without_preload_content( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to delete.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a user + + Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user. + + :param user_id: The ID of the user you want to delete. (required) + :type user_id: str + :param tenant_code: Specify the tenant to delete a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_user_serialize( + user_id=user_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "object", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_user_serialize( + self, + user_id, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/admin/users/{userId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_permissions_xlsx( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve permissions from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Retrieve a list of all permissions in XLSX format + + This API allows you to export the list of permissions in a tenant. This report includes the permission name, permission description, and permission ID for all permissions in the tenant. Administrating tenant users can export permissions lists for the administrating tenant and the analytic tenants those users belong to. + + :param tenant_code: Specify the tenant to retrieve permissions from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_permissions_xlsx_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_permissions_xlsx_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve permissions from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Retrieve a list of all permissions in XLSX format + + This API allows you to export the list of permissions in a tenant. This report includes the permission name, permission description, and permission ID for all permissions in the tenant. Administrating tenant users can export permissions lists for the administrating tenant and the analytic tenants those users belong to. + + :param tenant_code: Specify the tenant to retrieve permissions from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_permissions_xlsx_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_permissions_xlsx_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve permissions from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all permissions in XLSX format + + This API allows you to export the list of permissions in a tenant. This report includes the permission name, permission description, and permission ID for all permissions in the tenant. Administrating tenant users can export permissions lists for the administrating tenant and the analytic tenants those users belong to. + + :param tenant_code: Specify the tenant to retrieve permissions from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_permissions_xlsx_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_permissions_xlsx_serialize( + self, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.ms-excel', + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/users/reports/permissions-list', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_user_groups( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the list of user groups from.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of users to retrieve is 1000.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminUserGroupsGetAPIResponseDTO: + """Retrieve a list of all user groups + + This API allows you to retrieve the full list of user groups in a tenant. To specify the project in which to retrieve user groups for a tenant, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user information from production. + + :param tenant_code: Specify the tenant to retrieve the list of user groups from. + :type tenant_code: str + :param limit: The number of results to return. The maximum number of users to retrieve is 1000. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_user_groups_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupsGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_user_groups_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the list of user groups from.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of users to retrieve is 1000.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminUserGroupsGetAPIResponseDTO]: + """Retrieve a list of all user groups + + This API allows you to retrieve the full list of user groups in a tenant. To specify the project in which to retrieve user groups for a tenant, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user information from production. + + :param tenant_code: Specify the tenant to retrieve the list of user groups from. + :type tenant_code: str + :param limit: The number of results to return. The maximum number of users to retrieve is 1000. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_user_groups_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupsGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_user_groups_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the list of user groups from.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of users to retrieve is 1000.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all user groups + + This API allows you to retrieve the full list of user groups in a tenant. To specify the project in which to retrieve user groups for a tenant, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user information from production. + + :param tenant_code: Specify the tenant to retrieve the list of user groups from. + :type tenant_code: str + :param limit: The number of results to return. The maximum number of users to retrieve is 1000. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_user_groups_serialize( + tenant_code=tenant_code, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupsGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_user_groups_serialize( + self, + tenant_code, + limit, + start, + project_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/user-groups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_users( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a list of users from.")] = None, + assigned_profiles: Annotated[Optional[StrictBool], Field(description="If true, the response returns a list of the user's assigned profiles.")] = None, + assigned_permissions: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned permissions.")] = None, + assigned_user_groups: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned user groups.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of users to retrieve is 1000.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingAllUsersGetAPIResponseDTO: + """Retrieve a list of all users + + This API allows you to retrieve the full list of users and their current states. To specify the project in which to retrieve user information, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user information from production. + + :param tenant_code: Specify the tenant to retrieve a list of users from. + :type tenant_code: str + :param assigned_profiles: If true, the response returns a list of the user's assigned profiles. + :type assigned_profiles: bool + :param assigned_permissions: If true, the response returns the user's assigned permissions. + :type assigned_permissions: bool + :param assigned_user_groups: If true, the response returns the user's assigned user groups. + :type assigned_user_groups: bool + :param limit: The number of results to return. The maximum number of users to retrieve is 1000. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_users_serialize( + tenant_code=tenant_code, + assigned_profiles=assigned_profiles, + assigned_permissions=assigned_permissions, + assigned_user_groups=assigned_user_groups, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAllUsersGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_users_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a list of users from.")] = None, + assigned_profiles: Annotated[Optional[StrictBool], Field(description="If true, the response returns a list of the user's assigned profiles.")] = None, + assigned_permissions: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned permissions.")] = None, + assigned_user_groups: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned user groups.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of users to retrieve is 1000.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingAllUsersGetAPIResponseDTO]: + """Retrieve a list of all users + + This API allows you to retrieve the full list of users and their current states. To specify the project in which to retrieve user information, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user information from production. + + :param tenant_code: Specify the tenant to retrieve a list of users from. + :type tenant_code: str + :param assigned_profiles: If true, the response returns a list of the user's assigned profiles. + :type assigned_profiles: bool + :param assigned_permissions: If true, the response returns the user's assigned permissions. + :type assigned_permissions: bool + :param assigned_user_groups: If true, the response returns the user's assigned user groups. + :type assigned_user_groups: bool + :param limit: The number of results to return. The maximum number of users to retrieve is 1000. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_users_serialize( + tenant_code=tenant_code, + assigned_profiles=assigned_profiles, + assigned_permissions=assigned_permissions, + assigned_user_groups=assigned_user_groups, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAllUsersGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_users_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a list of users from.")] = None, + assigned_profiles: Annotated[Optional[StrictBool], Field(description="If true, the response returns a list of the user's assigned profiles.")] = None, + assigned_permissions: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned permissions.")] = None, + assigned_user_groups: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned user groups.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of users to retrieve is 1000.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of all users + + This API allows you to retrieve the full list of users and their current states. To specify the project in which to retrieve user information, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user information from production. + + :param tenant_code: Specify the tenant to retrieve a list of users from. + :type tenant_code: str + :param assigned_profiles: If true, the response returns a list of the user's assigned profiles. + :type assigned_profiles: bool + :param assigned_permissions: If true, the response returns the user's assigned permissions. + :type assigned_permissions: bool + :param assigned_user_groups: If true, the response returns the user's assigned user groups. + :type assigned_user_groups: bool + :param limit: The number of results to return. The maximum number of users to retrieve is 1000. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_users_serialize( + tenant_code=tenant_code, + assigned_profiles=assigned_profiles, + assigned_permissions=assigned_permissions, + assigned_user_groups=assigned_user_groups, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAllUsersGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_users_serialize( + self, + tenant_code, + assigned_profiles, + assigned_permissions, + assigned_user_groups, + limit, + start, + project_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if assigned_profiles is not None: + + _query_params.append(('assignedProfiles', assigned_profiles)) + + if assigned_permissions is not None: + + _query_params.append(('assignedPermissions', assigned_permissions)) + + if assigned_user_groups is not None: + + _query_params.append(('assignedUserGroups', assigned_user_groups)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_application_logs_xlsx( + self, + start_time: Annotated[Optional[StrictStr], Field(description="An inclusive date-time to start retrieving Application Logs from.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="An exclusive date-time to stop retrieving Application Logs from.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve Application Logs from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Retrieve the Application Logs + + This API allows you to export the Application Logs for a tenant. The Application Logs track information about your users and how they are using the application. Performing regular audits will help you identify potential security issues and keep your data safe. As part of user management, download the Application Logs to monitor user activity and logon events to ensure your users are performing authorized activities. Application logs are retained in the system for 180 days. Administrating tenant users can export application logs for the administrating tenant and the analytic tenants those users belong to. + + :param start_time: An inclusive date-time to start retrieving Application Logs from. + :type start_time: str + :param end_time: An exclusive date-time to stop retrieving Application Logs from. + :type end_time: str + :param tenant_code: Specify the tenant to retrieve Application Logs from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_application_logs_xlsx_serialize( + start_time=start_time, + end_time=end_time, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_application_logs_xlsx_with_http_info( + self, + start_time: Annotated[Optional[StrictStr], Field(description="An inclusive date-time to start retrieving Application Logs from.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="An exclusive date-time to stop retrieving Application Logs from.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve Application Logs from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Retrieve the Application Logs + + This API allows you to export the Application Logs for a tenant. The Application Logs track information about your users and how they are using the application. Performing regular audits will help you identify potential security issues and keep your data safe. As part of user management, download the Application Logs to monitor user activity and logon events to ensure your users are performing authorized activities. Application logs are retained in the system for 180 days. Administrating tenant users can export application logs for the administrating tenant and the analytic tenants those users belong to. + + :param start_time: An inclusive date-time to start retrieving Application Logs from. + :type start_time: str + :param end_time: An exclusive date-time to stop retrieving Application Logs from. + :type end_time: str + :param tenant_code: Specify the tenant to retrieve Application Logs from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_application_logs_xlsx_serialize( + start_time=start_time, + end_time=end_time, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_application_logs_xlsx_without_preload_content( + self, + start_time: Annotated[Optional[StrictStr], Field(description="An inclusive date-time to start retrieving Application Logs from.")] = None, + end_time: Annotated[Optional[StrictStr], Field(description="An exclusive date-time to stop retrieving Application Logs from.")] = None, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve Application Logs from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the Application Logs + + This API allows you to export the Application Logs for a tenant. The Application Logs track information about your users and how they are using the application. Performing regular audits will help you identify potential security issues and keep your data safe. As part of user management, download the Application Logs to monitor user activity and logon events to ensure your users are performing authorized activities. Application logs are retained in the system for 180 days. Administrating tenant users can export application logs for the administrating tenant and the analytic tenants those users belong to. + + :param start_time: An inclusive date-time to start retrieving Application Logs from. + :type start_time: str + :param end_time: An exclusive date-time to stop retrieving Application Logs from. + :type end_time: str + :param tenant_code: Specify the tenant to retrieve Application Logs from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_application_logs_xlsx_serialize( + start_time=start_time, + end_time=end_time, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_application_logs_xlsx_serialize( + self, + start_time, + end_time, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if start_time is not None: + + _query_params.append(('startTime', start_time)) + + if end_time is not None: + + _query_params.append(('endTime', end_time)) + + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.ms-excel', + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/users/reports/application-logs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_data_security_report_xlsx( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user to retrieve the report for.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the Data Security Report from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Retrieve the Data Security Report + + This API allows you to export the data security report of a user. The Data Security Report provides information about a specific user to see which populations and properties that user has access to as a result of the permissions assigned to them. Administrating tenant users can export the report for users in the administrating tenant and the analytic tenants those users belong to. + + :param user_id: The ID of the user to retrieve the report for. (required) + :type user_id: str + :param tenant_code: Specify the tenant to retrieve the Data Security Report from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_security_report_xlsx_serialize( + user_id=user_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_data_security_report_xlsx_with_http_info( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user to retrieve the report for.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the Data Security Report from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Retrieve the Data Security Report + + This API allows you to export the data security report of a user. The Data Security Report provides information about a specific user to see which populations and properties that user has access to as a result of the permissions assigned to them. Administrating tenant users can export the report for users in the administrating tenant and the analytic tenants those users belong to. + + :param user_id: The ID of the user to retrieve the report for. (required) + :type user_id: str + :param tenant_code: Specify the tenant to retrieve the Data Security Report from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_security_report_xlsx_serialize( + user_id=user_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_data_security_report_xlsx_without_preload_content( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user to retrieve the report for.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the Data Security Report from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the Data Security Report + + This API allows you to export the data security report of a user. The Data Security Report provides information about a specific user to see which populations and properties that user has access to as a result of the permissions assigned to them. Administrating tenant users can export the report for users in the administrating tenant and the analytic tenants those users belong to. + + :param user_id: The ID of the user to retrieve the report for. (required) + :type user_id: str + :param tenant_code: Specify the tenant to retrieve the Data Security Report from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_data_security_report_xlsx_serialize( + user_id=user_id, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_data_security_report_xlsx_serialize( + self, + user_id, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.ms-excel', + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/users/{userId}/reports/data-security', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_permission_assigned_users( + self, + permission_id: Annotated[StrictStr, Field(description="The unique identifier of the permission you want to retrieve users for.")], + include_user_groups: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns a list of all users that are assigned the permission, including users that are assigned the permission through a user group. If `false`, the response returns a list of the users that are directly assigned the permission.")] = None, + tenant_filter: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the list of users from.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of tenants to retrieve is 100.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingPermissionAssignedUsersDTO: + """Retrieve users that are assigned a specific permission + + This API allows you to retrieve all the users that are assigned a specified permission. You must know the ID of the permission you want to retrieve users for. To specify the project in which to retrieve users assigned to a specific permission for the login tenant, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves users assigned to a specific permission from production. + + :param permission_id: The unique identifier of the permission you want to retrieve users for. (required) + :type permission_id: str + :param include_user_groups: If `true`, the response returns a list of all users that are assigned the permission, including users that are assigned the permission through a user group. If `false`, the response returns a list of the users that are directly assigned the permission. + :type include_user_groups: bool + :param tenant_filter: Specify the tenant to retrieve the list of users from. + :type tenant_filter: str + :param limit: The number of results to return. The maximum number of tenants to retrieve is 100. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_permission_assigned_users_serialize( + permission_id=permission_id, + include_user_groups=include_user_groups, + tenant_filter=tenant_filter, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionAssignedUsersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_permission_assigned_users_with_http_info( + self, + permission_id: Annotated[StrictStr, Field(description="The unique identifier of the permission you want to retrieve users for.")], + include_user_groups: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns a list of all users that are assigned the permission, including users that are assigned the permission through a user group. If `false`, the response returns a list of the users that are directly assigned the permission.")] = None, + tenant_filter: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the list of users from.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of tenants to retrieve is 100.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingPermissionAssignedUsersDTO]: + """Retrieve users that are assigned a specific permission + + This API allows you to retrieve all the users that are assigned a specified permission. You must know the ID of the permission you want to retrieve users for. To specify the project in which to retrieve users assigned to a specific permission for the login tenant, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves users assigned to a specific permission from production. + + :param permission_id: The unique identifier of the permission you want to retrieve users for. (required) + :type permission_id: str + :param include_user_groups: If `true`, the response returns a list of all users that are assigned the permission, including users that are assigned the permission through a user group. If `false`, the response returns a list of the users that are directly assigned the permission. + :type include_user_groups: bool + :param tenant_filter: Specify the tenant to retrieve the list of users from. + :type tenant_filter: str + :param limit: The number of results to return. The maximum number of tenants to retrieve is 100. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_permission_assigned_users_serialize( + permission_id=permission_id, + include_user_groups=include_user_groups, + tenant_filter=tenant_filter, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionAssignedUsersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_permission_assigned_users_without_preload_content( + self, + permission_id: Annotated[StrictStr, Field(description="The unique identifier of the permission you want to retrieve users for.")], + include_user_groups: Annotated[Optional[StrictBool], Field(description="If `true`, the response returns a list of all users that are assigned the permission, including users that are assigned the permission through a user group. If `false`, the response returns a list of the users that are directly assigned the permission.")] = None, + tenant_filter: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the list of users from.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of tenants to retrieve is 100.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve users that are assigned a specific permission + + This API allows you to retrieve all the users that are assigned a specified permission. You must know the ID of the permission you want to retrieve users for. To specify the project in which to retrieve users assigned to a specific permission for the login tenant, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves users assigned to a specific permission from production. + + :param permission_id: The unique identifier of the permission you want to retrieve users for. (required) + :type permission_id: str + :param include_user_groups: If `true`, the response returns a list of all users that are assigned the permission, including users that are assigned the permission through a user group. If `false`, the response returns a list of the users that are directly assigned the permission. + :type include_user_groups: bool + :param tenant_filter: Specify the tenant to retrieve the list of users from. + :type tenant_filter: str + :param limit: The number of results to return. The maximum number of tenants to retrieve is 100. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_permission_assigned_users_serialize( + permission_id=permission_id, + include_user_groups=include_user_groups, + tenant_filter=tenant_filter, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingPermissionAssignedUsersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_permission_assigned_users_serialize( + self, + permission_id, + include_user_groups, + tenant_filter, + limit, + start, + project_id, + target_tenant_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if permission_id is not None: + _path_params['permissionId'] = permission_id + # process the query parameters + if include_user_groups is not None: + + _query_params.append(('includeUserGroups', include_user_groups)) + + if tenant_filter is not None: + + _query_params.append(('tenantFilter', tenant_filter)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/permissions/{permissionId}/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_profile_assignments_xlsx( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve profile assignments from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Retrieve user profile assignments in XLSX format + + This API allows you to export the profiles assigned to each user. This report details the profiles assigned to each user and the profile validity period. Administrating tenant users can export profile assignments for the administrating tenant and the analytic tenants those users belong to. + + :param tenant_code: Specify the tenant to retrieve profile assignments from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_profile_assignments_xlsx_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_profile_assignments_xlsx_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve profile assignments from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Retrieve user profile assignments in XLSX format + + This API allows you to export the profiles assigned to each user. This report details the profiles assigned to each user and the profile validity period. Administrating tenant users can export profile assignments for the administrating tenant and the analytic tenants those users belong to. + + :param tenant_code: Specify the tenant to retrieve profile assignments from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_profile_assignments_xlsx_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_profile_assignments_xlsx_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve profile assignments from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve user profile assignments in XLSX format + + This API allows you to export the profiles assigned to each user. This report details the profiles assigned to each user and the profile validity period. Administrating tenant users can export profile assignments for the administrating tenant and the analytic tenants those users belong to. + + :param tenant_code: Specify the tenant to retrieve profile assignments from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_profile_assignments_xlsx_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_profile_assignments_xlsx_serialize( + self, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.ms-excel', + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/users/reports/profile-assignments', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_user_detail( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a user from.")] = None, + assigned_profiles: Annotated[Optional[StrictBool], Field(description="If true, the response returns a list of the user's assigned profiles.")] = None, + assigned_permissions: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned permissions.")] = None, + assigned_user_groups: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned user groups.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingUserGetAPIResponseDTO: + """Retrieve a user's details + + This API allows you to retrieve all details for a specified user. To specify the project in which to retrieve user information, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user information from production. + + :param user_id: The ID of the user you want to retrieve. (required) + :type user_id: str + :param tenant_code: Specify the tenant to retrieve a user from. + :type tenant_code: str + :param assigned_profiles: If true, the response returns a list of the user's assigned profiles. + :type assigned_profiles: bool + :param assigned_permissions: If true, the response returns the user's assigned permissions. + :type assigned_permissions: bool + :param assigned_user_groups: If true, the response returns the user's assigned user groups. + :type assigned_user_groups: bool + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_detail_serialize( + user_id=user_id, + tenant_code=tenant_code, + assigned_profiles=assigned_profiles, + assigned_permissions=assigned_permissions, + assigned_user_groups=assigned_user_groups, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUserGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_detail_with_http_info( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a user from.")] = None, + assigned_profiles: Annotated[Optional[StrictBool], Field(description="If true, the response returns a list of the user's assigned profiles.")] = None, + assigned_permissions: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned permissions.")] = None, + assigned_user_groups: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned user groups.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingUserGetAPIResponseDTO]: + """Retrieve a user's details + + This API allows you to retrieve all details for a specified user. To specify the project in which to retrieve user information, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user information from production. + + :param user_id: The ID of the user you want to retrieve. (required) + :type user_id: str + :param tenant_code: Specify the tenant to retrieve a user from. + :type tenant_code: str + :param assigned_profiles: If true, the response returns a list of the user's assigned profiles. + :type assigned_profiles: bool + :param assigned_permissions: If true, the response returns the user's assigned permissions. + :type assigned_permissions: bool + :param assigned_user_groups: If true, the response returns the user's assigned user groups. + :type assigned_user_groups: bool + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_detail_serialize( + user_id=user_id, + tenant_code=tenant_code, + assigned_profiles=assigned_profiles, + assigned_permissions=assigned_permissions, + assigned_user_groups=assigned_user_groups, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUserGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_detail_without_preload_content( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to retrieve.")], + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve a user from.")] = None, + assigned_profiles: Annotated[Optional[StrictBool], Field(description="If true, the response returns a list of the user's assigned profiles.")] = None, + assigned_permissions: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned permissions.")] = None, + assigned_user_groups: Annotated[Optional[StrictBool], Field(description="If true, the response returns the user's assigned user groups.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a user's details + + This API allows you to retrieve all details for a specified user. To specify the project in which to retrieve user information, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user information from production. + + :param user_id: The ID of the user you want to retrieve. (required) + :type user_id: str + :param tenant_code: Specify the tenant to retrieve a user from. + :type tenant_code: str + :param assigned_profiles: If true, the response returns a list of the user's assigned profiles. + :type assigned_profiles: bool + :param assigned_permissions: If true, the response returns the user's assigned permissions. + :type assigned_permissions: bool + :param assigned_user_groups: If true, the response returns the user's assigned user groups. + :type assigned_user_groups: bool + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_detail_serialize( + user_id=user_id, + tenant_code=tenant_code, + assigned_profiles=assigned_profiles, + assigned_permissions=assigned_permissions, + assigned_user_groups=assigned_user_groups, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUserGetAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_detail_serialize( + self, + user_id, + tenant_code, + assigned_profiles, + assigned_permissions, + assigned_user_groups, + project_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + if assigned_profiles is not None: + + _query_params.append(('assignedProfiles', assigned_profiles)) + + if assigned_permissions is not None: + + _query_params.append(('assignedPermissions', assigned_permissions)) + + if assigned_user_groups is not None: + + _query_params.append(('assignedUserGroups', assigned_user_groups)) + + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/users/{userId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_user_group_users( + self, + user_group_id: Annotated[StrictStr, Field(description="The ID of user group.")], + tenant_filter: Annotated[Optional[StrictStr], Field(description="Specifies the tenant to retrieve the list of users from.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of tenants to retrieve is 100.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminUserGroupsUsersDTO: + """Retrieve a list of user group users + + This API allows you to retrieve the list of users explicitly assigned to a user group. Users that are implicitly included in the user group through the user group's dynamic filters are not returned by this endpoint. To specify the project in which to retrieve user group users for the login tenant, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user group users from production. + + :param user_group_id: The ID of user group. (required) + :type user_group_id: str + :param tenant_filter: Specifies the tenant to retrieve the list of users from. + :type tenant_filter: str + :param limit: The number of results to return. The maximum number of tenants to retrieve is 100. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_users_serialize( + user_group_id=user_group_id, + tenant_filter=tenant_filter, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupsUsersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_group_users_with_http_info( + self, + user_group_id: Annotated[StrictStr, Field(description="The ID of user group.")], + tenant_filter: Annotated[Optional[StrictStr], Field(description="Specifies the tenant to retrieve the list of users from.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of tenants to retrieve is 100.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminUserGroupsUsersDTO]: + """Retrieve a list of user group users + + This API allows you to retrieve the list of users explicitly assigned to a user group. Users that are implicitly included in the user group through the user group's dynamic filters are not returned by this endpoint. To specify the project in which to retrieve user group users for the login tenant, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user group users from production. + + :param user_group_id: The ID of user group. (required) + :type user_group_id: str + :param tenant_filter: Specifies the tenant to retrieve the list of users from. + :type tenant_filter: str + :param limit: The number of results to return. The maximum number of tenants to retrieve is 100. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_users_serialize( + user_group_id=user_group_id, + tenant_filter=tenant_filter, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupsUsersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_group_users_without_preload_content( + self, + user_group_id: Annotated[StrictStr, Field(description="The ID of user group.")], + tenant_filter: Annotated[Optional[StrictStr], Field(description="Specifies the tenant to retrieve the list of users from.")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The number of results to return. The maximum number of tenants to retrieve is 100.")] = None, + start: Annotated[Optional[StrictInt], Field(description="The index to start retrieving results from, also known as offset. The index begins at 0.")] = None, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of user group users + + This API allows you to retrieve the list of users explicitly assigned to a user group. Users that are implicitly included in the user group through the user group's dynamic filters are not returned by this endpoint. To specify the project in which to retrieve user group users for the login tenant, provide a project UUID in the `ProjectID` request header. If omitted, the request retrieves user group users from production. + + :param user_group_id: The ID of user group. (required) + :type user_group_id: str + :param tenant_filter: Specifies the tenant to retrieve the list of users from. + :type tenant_filter: str + :param limit: The number of results to return. The maximum number of tenants to retrieve is 100. + :type limit: int + :param start: The index to start retrieving results from, also known as offset. The index begins at 0. + :type start: int + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_group_users_serialize( + user_group_id=user_group_id, + tenant_filter=tenant_filter, + limit=limit, + start=start, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminUserGroupsUsersDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_group_users_serialize( + self, + user_group_id, + tenant_filter, + limit, + start, + project_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_group_id is not None: + _path_params['userGroupId'] = user_group_id + # process the query parameters + if tenant_filter is not None: + + _query_params.append(('tenantFilter', tenant_filter)) + + if limit is not None: + + _query_params.append(('limit', limit)) + + if start is not None: + + _query_params.append(('start', start)) + + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/user-groups/{userGroupId}/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_user_permissions_xlsx( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the permission assignments report from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Retrieve user permissions in XLSX format + + This API allows you to export the user permission assignments for a tenant. The permission assignments report provides a summary of the permissions your users have been assigned and how each permission is being used across your user base, as well as the users that do not have any permissions assigned to them. Administrating tenant users can export permission assignments for the administrating tenant and the analytic tenants those users belong to. + + :param tenant_code: Specify the tenant to retrieve the permission assignments report from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_permissions_xlsx_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_user_permissions_xlsx_with_http_info( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the permission assignments report from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Retrieve user permissions in XLSX format + + This API allows you to export the user permission assignments for a tenant. The permission assignments report provides a summary of the permissions your users have been assigned and how each permission is being used across your user base, as well as the users that do not have any permissions assigned to them. Administrating tenant users can export permission assignments for the administrating tenant and the analytic tenants those users belong to. + + :param tenant_code: Specify the tenant to retrieve the permission assignments report from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_permissions_xlsx_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_user_permissions_xlsx_without_preload_content( + self, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to retrieve the permission assignments report from.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve user permissions in XLSX format + + This API allows you to export the user permission assignments for a tenant. The permission assignments report provides a summary of the permissions your users have been assigned and how each permission is being used across your user base, as well as the users that do not have any permissions assigned to them. Administrating tenant users can export permission assignments for the administrating tenant and the analytic tenants those users belong to. + + :param tenant_code: Specify the tenant to retrieve the permission assignments report from. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_user_permissions_xlsx_serialize( + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_user_permissions_xlsx_serialize( + self, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/vnd.ms-excel', + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/admin/users/reports/permission-assignments', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def remove_permissions( + self, + servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingAssignRevokePermissionsResponseDTO: + """Remove permissions from users + + This API allows you to remove a permission from specific users. Administrating tenant users can remove permissions from users in the administrating tenant and in the analytic tenants those users belong to. To remove permission from users in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can remove permissions from users in analytic tenants by providing a tenant code and project ID in the request body. + + :param servicing_assign_revoke_permissions_request_dto: (required) + :type servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_permissions_serialize( + servicing_assign_revoke_permissions_request_dto=servicing_assign_revoke_permissions_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAssignRevokePermissionsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def remove_permissions_with_http_info( + self, + servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingAssignRevokePermissionsResponseDTO]: + """Remove permissions from users + + This API allows you to remove a permission from specific users. Administrating tenant users can remove permissions from users in the administrating tenant and in the analytic tenants those users belong to. To remove permission from users in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can remove permissions from users in analytic tenants by providing a tenant code and project ID in the request body. + + :param servicing_assign_revoke_permissions_request_dto: (required) + :type servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_permissions_serialize( + servicing_assign_revoke_permissions_request_dto=servicing_assign_revoke_permissions_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAssignRevokePermissionsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def remove_permissions_without_preload_content( + self, + servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Remove permissions from users + + This API allows you to remove a permission from specific users. Administrating tenant users can remove permissions from users in the administrating tenant and in the analytic tenants those users belong to. To remove permission from users in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can remove permissions from users in analytic tenants by providing a tenant code and project ID in the request body. + + :param servicing_assign_revoke_permissions_request_dto: (required) + :type servicing_assign_revoke_permissions_request_dto: ServicingAssignRevokePermissionsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_permissions_serialize( + servicing_assign_revoke_permissions_request_dto=servicing_assign_revoke_permissions_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingAssignRevokePermissionsResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _remove_permissions_serialize( + self, + servicing_assign_revoke_permissions_request_dto, + project_id, + target_tenant_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if servicing_assign_revoke_permissions_request_dto is not None: + _body_params = servicing_assign_revoke_permissions_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/admin/permissions/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def remove_users_from_user_group( + self, + admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminSecurityAssignmentResponseDTO: + """Remove users from user groups + + This API allows you to remove users from specific user groups. To remove users from user groups in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can remove users to user groups in multiple analytic tenants by providing a tenant code and project ID in the request body. We recommend that administrating tenants set the analytic tenant in which to execute the API call using the `TargetTenantID` request header. + + :param admin_users_to_user_groups_request_dto: (required) + :type admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_users_from_user_group_serialize( + admin_users_to_user_groups_request_dto=admin_users_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminSecurityAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def remove_users_from_user_group_with_http_info( + self, + admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminSecurityAssignmentResponseDTO]: + """Remove users from user groups + + This API allows you to remove users from specific user groups. To remove users from user groups in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can remove users to user groups in multiple analytic tenants by providing a tenant code and project ID in the request body. We recommend that administrating tenants set the analytic tenant in which to execute the API call using the `TargetTenantID` request header. + + :param admin_users_to_user_groups_request_dto: (required) + :type admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_users_from_user_group_serialize( + admin_users_to_user_groups_request_dto=admin_users_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminSecurityAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def remove_users_from_user_group_without_preload_content( + self, + admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + non_versioned: Annotated[Optional[StrictBool], Field(description="If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Remove users from user groups + + This API allows you to remove users from specific user groups. To remove users from user groups in a project for the administrating tenant, provide a project UUID in the `ProjectID` request header. Administrating tenants can remove users to user groups in multiple analytic tenants by providing a tenant code and project ID in the request body. We recommend that administrating tenants set the analytic tenant in which to execute the API call using the `TargetTenantID` request header. + + :param admin_users_to_user_groups_request_dto: (required) + :type admin_users_to_user_groups_request_dto: AdminUsersToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param non_versioned: If `true`, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If `false`, the API call executes on versioned artifacts and create/update actions release a new production version. Default is `false`.
**Note:** This header is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM). + :type non_versioned: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._remove_users_from_user_group_serialize( + admin_users_to_user_groups_request_dto=admin_users_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + non_versioned=non_versioned, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminSecurityAssignmentResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _remove_users_from_user_group_serialize( + self, + admin_users_to_user_groups_request_dto, + project_id, + target_tenant_id, + non_versioned, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + if non_versioned is not None: + _header_params['NonVersioned'] = non_versioned + # process the form parameters + # process the body parameter + if admin_users_to_user_groups_request_dto is not None: + _body_params = admin_users_to_user_groups_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/admin/user-groups/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def revoke_permissions_from_user_groups( + self, + admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AdminPermissionsToUserGroupForTenantDTO: + """Remove permissions from user groups + + This API allows you to remove a permission from specific user groups. To remove permissions from user groups in a project, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_to_user_groups_request_dto: (required) + :type admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._revoke_permissions_from_user_groups_serialize( + admin_permissions_to_user_groups_request_dto=admin_permissions_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminPermissionsToUserGroupForTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def revoke_permissions_from_user_groups_with_http_info( + self, + admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AdminPermissionsToUserGroupForTenantDTO]: + """Remove permissions from user groups + + This API allows you to remove a permission from specific user groups. To remove permissions from user groups in a project, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_to_user_groups_request_dto: (required) + :type admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._revoke_permissions_from_user_groups_serialize( + admin_permissions_to_user_groups_request_dto=admin_permissions_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminPermissionsToUserGroupForTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def revoke_permissions_from_user_groups_without_preload_content( + self, + admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO, + project_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify a project in which to make the request. If omitted, the request uses the production version.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Remove permissions from user groups + + This API allows you to remove a permission from specific user groups. To remove permissions from user groups in a project, provide a project UUID in the `ProjectID` request header. + + :param admin_permissions_to_user_groups_request_dto: (required) + :type admin_permissions_to_user_groups_request_dto: AdminPermissionsToUserGroupsRequestDTO + :param project_id: Optionally, specify a project in which to make the request. If omitted, the request uses the production version. + :type project_id: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._revoke_permissions_from_user_groups_serialize( + admin_permissions_to_user_groups_request_dto=admin_permissions_to_user_groups_request_dto, + project_id=project_id, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AdminPermissionsToUserGroupForTenantDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _revoke_permissions_from_user_groups_serialize( + self, + admin_permissions_to_user_groups_request_dto, + project_id, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if project_id is not None: + _header_params['ProjectID'] = project_id + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if admin_permissions_to_user_groups_request_dto is not None: + _body_params = admin_permissions_to_user_groups_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1/admin/user-groups/permissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_user( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to update.")], + servicing_user_update_api_request_dto: ServicingUserUpdateAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingUserUpdateAPIRequestDTO: + """Update a user + + Update an existing user's information, such as their display name or if the user is enabled in Visier. + + :param user_id: The ID of the user you want to update. (required) + :type user_id: str + :param servicing_user_update_api_request_dto: (required) + :type servicing_user_update_api_request_dto: ServicingUserUpdateAPIRequestDTO + :param tenant_code: Specify the tenant to update a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_user_serialize( + user_id=user_id, + servicing_user_update_api_request_dto=servicing_user_update_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUserUpdateAPIRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_user_with_http_info( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to update.")], + servicing_user_update_api_request_dto: ServicingUserUpdateAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingUserUpdateAPIRequestDTO]: + """Update a user + + Update an existing user's information, such as their display name or if the user is enabled in Visier. + + :param user_id: The ID of the user you want to update. (required) + :type user_id: str + :param servicing_user_update_api_request_dto: (required) + :type servicing_user_update_api_request_dto: ServicingUserUpdateAPIRequestDTO + :param tenant_code: Specify the tenant to update a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_user_serialize( + user_id=user_id, + servicing_user_update_api_request_dto=servicing_user_update_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUserUpdateAPIRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_user_without_preload_content( + self, + user_id: Annotated[StrictStr, Field(description="The ID of the user you want to update.")], + servicing_user_update_api_request_dto: ServicingUserUpdateAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update a user + + Update an existing user's information, such as their display name or if the user is enabled in Visier. + + :param user_id: The ID of the user you want to update. (required) + :type user_id: str + :param servicing_user_update_api_request_dto: (required) + :type servicing_user_update_api_request_dto: ServicingUserUpdateAPIRequestDTO + :param tenant_code: Specify the tenant to update a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_user_serialize( + user_id=user_id, + servicing_user_update_api_request_dto=servicing_user_update_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUserUpdateAPIRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_user_serialize( + self, + user_id, + servicing_user_update_api_request_dto, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_user_update_api_request_dto is not None: + _body_params = servicing_user_update_api_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1/admin/users/{userId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/users_v2_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/users_v2_api.py new file mode 100644 index 0000000000..0b21cac2e3 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/users_v2_api.py @@ -0,0 +1,973 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.servicing_users_api_response_dto import ServicingUsersAPIResponseDTO +from visier_platform_sdk.models.servicing_users_creation_api_request_dto import ServicingUsersCreationAPIRequestDTO +from visier_platform_sdk.models.servicing_users_delete_api_request_dto import ServicingUsersDeleteAPIRequestDTO +from visier_platform_sdk.models.servicing_users_update_api_request_dto import ServicingUsersUpdateAPIRequestDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class UsersV2Api: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def add_users( + self, + servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingUsersAPIResponseDTO: + """Add users + + Create new users. Administrating tenant users can specify the tenant in which to add these users. + + :param servicing_users_creation_api_request_dto: (required) + :type servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO + :param tenant_code: Specify the tenant to create a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_users_serialize( + servicing_users_creation_api_request_dto=servicing_users_creation_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUsersAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def add_users_with_http_info( + self, + servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingUsersAPIResponseDTO]: + """Add users + + Create new users. Administrating tenant users can specify the tenant in which to add these users. + + :param servicing_users_creation_api_request_dto: (required) + :type servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO + :param tenant_code: Specify the tenant to create a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_users_serialize( + servicing_users_creation_api_request_dto=servicing_users_creation_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUsersAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def add_users_without_preload_content( + self, + servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to create a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Add users + + Create new users. Administrating tenant users can specify the tenant in which to add these users. + + :param servicing_users_creation_api_request_dto: (required) + :type servicing_users_creation_api_request_dto: ServicingUsersCreationAPIRequestDTO + :param tenant_code: Specify the tenant to create a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._add_users_serialize( + servicing_users_creation_api_request_dto=servicing_users_creation_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUsersAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _add_users_serialize( + self, + servicing_users_creation_api_request_dto, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_users_creation_api_request_dto is not None: + _body_params = servicing_users_creation_api_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v2/admin/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_users( + self, + servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingUsersAPIResponseDTO: + """Delete users + + Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user. + + :param servicing_users_delete_api_request_dto: (required) + :type servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO + :param tenant_code: Specify the tenant to delete a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_users_serialize( + servicing_users_delete_api_request_dto=servicing_users_delete_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUsersAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_users_with_http_info( + self, + servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingUsersAPIResponseDTO]: + """Delete users + + Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user. + + :param servicing_users_delete_api_request_dto: (required) + :type servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO + :param tenant_code: Specify the tenant to delete a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_users_serialize( + servicing_users_delete_api_request_dto=servicing_users_delete_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUsersAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_users_without_preload_content( + self, + servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to delete a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete users + + Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user. + + :param servicing_users_delete_api_request_dto: (required) + :type servicing_users_delete_api_request_dto: ServicingUsersDeleteAPIRequestDTO + :param tenant_code: Specify the tenant to delete a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_users_serialize( + servicing_users_delete_api_request_dto=servicing_users_delete_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUsersAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_users_serialize( + self, + servicing_users_delete_api_request_dto, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_users_delete_api_request_dto is not None: + _body_params = servicing_users_delete_api_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v2/admin/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_users( + self, + servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ServicingUsersAPIResponseDTO: + """Update users + + Update an existing user's information, such as their display name or if the user is enabled in Visier. + + :param servicing_users_update_api_request_dto: (required) + :type servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO + :param tenant_code: Specify the tenant to update a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_users_serialize( + servicing_users_update_api_request_dto=servicing_users_update_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUsersAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_users_with_http_info( + self, + servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ServicingUsersAPIResponseDTO]: + """Update users + + Update an existing user's information, such as their display name or if the user is enabled in Visier. + + :param servicing_users_update_api_request_dto: (required) + :type servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO + :param tenant_code: Specify the tenant to update a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_users_serialize( + servicing_users_update_api_request_dto=servicing_users_update_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUsersAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_users_without_preload_content( + self, + servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO, + tenant_code: Annotated[Optional[StrictStr], Field(description="Specify the tenant to update a user in.")] = None, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update users + + Update an existing user's information, such as their display name or if the user is enabled in Visier. + + :param servicing_users_update_api_request_dto: (required) + :type servicing_users_update_api_request_dto: ServicingUsersUpdateAPIRequestDTO + :param tenant_code: Specify the tenant to update a user in. + :type tenant_code: str + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_users_serialize( + servicing_users_update_api_request_dto=servicing_users_update_api_request_dto, + tenant_code=tenant_code, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ServicingUsersAPIResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_users_serialize( + self, + servicing_users_update_api_request_dto, + tenant_code, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if tenant_code is not None: + + _query_params.append(('tenantCode', tenant_code)) + + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if servicing_users_update_api_request_dto is not None: + _body_params = servicing_users_update_api_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v2/admin/users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/vee_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/vee_api.py new file mode 100644 index 0000000000..ee9e715cc2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/vee_api.py @@ -0,0 +1,1161 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.analysis_common_vee_feedback_dto import AnalysisCommonVeeFeedbackDTO +from visier_platform_sdk.models.analysis_common_vee_question_dto import AnalysisCommonVeeQuestionDTO +from visier_platform_sdk.models.analysis_common_vee_response_dto import AnalysisCommonVeeResponseDTO +from visier_platform_sdk.models.analysis_common_vee_sample_question_library_dto import AnalysisCommonVeeSampleQuestionLibraryDTO +from visier_platform_sdk.models.analysis_common_vee_status_code_dto import AnalysisCommonVeeStatusCodeDTO +from visier_platform_sdk.models.systemstatus_vee_status_dto import SystemstatusVeeStatusDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class VeeApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def vee_feedback( + self, + analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnalysisCommonVeeStatusCodeDTO: + """Submit Vee feedback + + Give Vee feedback for a previous answer. To submit feedback, include: * The response object from the `/question` response. * A rating of Vee's answer. If `isApproved` is `true`, Vee answered the question correctly. If `isApproved` is `false`, Vee's answer was incorrect or lacked details. * A description of how Vee should have answered the question or how Vee can improve the answer, such as \"Expected Headcount metric, but Vee returned Average Headcount\".
**Note:** 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). + + :param analysis_common_vee_feedback_dto: (required) + :type analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_feedback_serialize( + analysis_common_vee_feedback_dto=analysis_common_vee_feedback_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonVeeStatusCodeDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def vee_feedback_with_http_info( + self, + analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnalysisCommonVeeStatusCodeDTO]: + """Submit Vee feedback + + Give Vee feedback for a previous answer. To submit feedback, include: * The response object from the `/question` response. * A rating of Vee's answer. If `isApproved` is `true`, Vee answered the question correctly. If `isApproved` is `false`, Vee's answer was incorrect or lacked details. * A description of how Vee should have answered the question or how Vee can improve the answer, such as \"Expected Headcount metric, but Vee returned Average Headcount\".
**Note:** 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). + + :param analysis_common_vee_feedback_dto: (required) + :type analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_feedback_serialize( + analysis_common_vee_feedback_dto=analysis_common_vee_feedback_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonVeeStatusCodeDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def vee_feedback_without_preload_content( + self, + analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Submit Vee feedback + + Give Vee feedback for a previous answer. To submit feedback, include: * The response object from the `/question` response. * A rating of Vee's answer. If `isApproved` is `true`, Vee answered the question correctly. If `isApproved` is `false`, Vee's answer was incorrect or lacked details. * A description of how Vee should have answered the question or how Vee can improve the answer, such as \"Expected Headcount metric, but Vee returned Average Headcount\".
**Note:** 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). + + :param analysis_common_vee_feedback_dto: (required) + :type analysis_common_vee_feedback_dto: AnalysisCommonVeeFeedbackDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_feedback_serialize( + analysis_common_vee_feedback_dto=analysis_common_vee_feedback_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonVeeStatusCodeDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _vee_feedback_serialize( + self, + analysis_common_vee_feedback_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if analysis_common_vee_feedback_dto is not None: + _body_params = analysis_common_vee_feedback_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/vee/feedback', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def vee_question_request( + self, + analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnalysisCommonVeeResponseDTO: + """Ask Vee a question + + Use plain language to ask Vee a people question. Use body parameters to specify how Vee should respond, such as returning a visualization, data, or rewording the question. The response always returns a `conversationState` object containing a unique ID for the conversation. To ask a follow-up question or continue the conversation with Vee, include the `conversationState` from the response in your next `/question` call. To submit feedback about Vee's answer, copy the entire response into your `/feedback` call.
**Note:** 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). + + :param analysis_common_vee_question_dto: (required) + :type analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_question_request_serialize( + analysis_common_vee_question_dto=analysis_common_vee_question_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonVeeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def vee_question_request_with_http_info( + self, + analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnalysisCommonVeeResponseDTO]: + """Ask Vee a question + + Use plain language to ask Vee a people question. Use body parameters to specify how Vee should respond, such as returning a visualization, data, or rewording the question. The response always returns a `conversationState` object containing a unique ID for the conversation. To ask a follow-up question or continue the conversation with Vee, include the `conversationState` from the response in your next `/question` call. To submit feedback about Vee's answer, copy the entire response into your `/feedback` call.
**Note:** 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). + + :param analysis_common_vee_question_dto: (required) + :type analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_question_request_serialize( + analysis_common_vee_question_dto=analysis_common_vee_question_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonVeeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def vee_question_request_without_preload_content( + self, + analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Ask Vee a question + + Use plain language to ask Vee a people question. Use body parameters to specify how Vee should respond, such as returning a visualization, data, or rewording the question. The response always returns a `conversationState` object containing a unique ID for the conversation. To ask a follow-up question or continue the conversation with Vee, include the `conversationState` from the response in your next `/question` call. To submit feedback about Vee's answer, copy the entire response into your `/feedback` call.
**Note:** 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). + + :param analysis_common_vee_question_dto: (required) + :type analysis_common_vee_question_dto: AnalysisCommonVeeQuestionDTO + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_question_request_serialize( + analysis_common_vee_question_dto=analysis_common_vee_question_dto, + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonVeeResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _vee_question_request_serialize( + self, + analysis_common_vee_question_dto, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + if analysis_common_vee_question_dto is not None: + _body_params = analysis_common_vee_question_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1alpha/vee/question', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def vee_sample_questions( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AnalysisCommonVeeSampleQuestionLibraryDTO: + """Retrieve a list of sample questions to ask Vee + + Get a list of sample questions to help you start using Vee. The response returns a list of questions that you can ask Vee, such as \"What is the turnover rate?\". You may occasionally encounter a sample question that can't be answered due to data availability or your data access
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_sample_questions_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonVeeSampleQuestionLibraryDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def vee_sample_questions_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AnalysisCommonVeeSampleQuestionLibraryDTO]: + """Retrieve a list of sample questions to ask Vee + + Get a list of sample questions to help you start using Vee. The response returns a list of questions that you can ask Vee, such as \"What is the turnover rate?\". You may occasionally encounter a sample question that can't be answered due to data availability or your data access
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_sample_questions_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonVeeSampleQuestionLibraryDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def vee_sample_questions_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of sample questions to ask Vee + + Get a list of sample questions to help you start using Vee. The response returns a list of questions that you can ask Vee, such as \"What is the turnover rate?\". You may occasionally encounter a sample question that can't be answered due to data availability or your data access
**Note:** 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). + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_sample_questions_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AnalysisCommonVeeSampleQuestionLibraryDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _vee_sample_questions_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1alpha/vee/sample-questions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def vee_status( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SystemstatusVeeStatusDTO: + """Check the overall current status of Vee + + Check the current overall status of Vee. The overall status is one of: * `UP` : Vee is operational. * `DOWN`: Vee is not operational. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_status_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemstatusVeeStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def vee_status_with_http_info( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SystemstatusVeeStatusDTO]: + """Check the overall current status of Vee + + Check the current overall status of Vee. The overall status is one of: * `UP` : Vee is operational. * `DOWN`: Vee is not operational. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_status_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemstatusVeeStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def vee_status_without_preload_content( + self, + 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, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Check the overall current status of Vee + + Check the current overall status of Vee. The overall status is one of: * `UP` : Vee is operational. * `DOWN`: Vee is not operational. + + :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. + :type target_tenant_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._vee_status_serialize( + target_tenant_id=target_tenant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemstatusVeeStatusDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _vee_status_serialize( + self, + target_tenant_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + if target_tenant_id is not None: + _header_params['TargetTenantID'] = target_tenant_id + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1/vee/status', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api/webhooks_api.py b/src/visier_platform_sdk/visier_platform_sdk/api/webhooks_api.py new file mode 100644 index 0000000000..d0430747c1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api/webhooks_api.py @@ -0,0 +1,2281 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictStr +from typing import Optional +from typing_extensions import Annotated +from visier_platform_sdk.models.designer_webhook_webhook_credentials_dto import DesignerWebhookWebhookCredentialsDTO +from visier_platform_sdk.models.designer_webhook_webhook_dto import DesignerWebhookWebhookDTO +from visier_platform_sdk.models.designer_webhook_webhook_event_type_dto import DesignerWebhookWebhookEventTypeDTO +from visier_platform_sdk.models.designer_webhook_webhook_message_response_dto import DesignerWebhookWebhookMessageResponseDTO +from visier_platform_sdk.models.designer_webhook_webhook_request_dto import DesignerWebhookWebhookRequestDTO +from visier_platform_sdk.models.designer_webhook_webhooks_dto import DesignerWebhookWebhooksDTO + +from visier_platform_sdk.api_client import ApiClient, RequestSerialized +from visier_platform_sdk.api_response import ApiResponse +from visier_platform_sdk.rest import RESTResponseType + + +class WebhooksApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def create_webhook( + self, + designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerWebhookWebhookDTO: + """Create a webhook + + Create a new webhook with Visier. You must specify the webhook's endpoint URL, its active status, the event types to listen for, and the credentials to authenticate calls to the webhook endpoint.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param designer_webhook_webhook_request_dto: (required) + :type designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_webhook_serialize( + designer_webhook_webhook_request_dto=designer_webhook_webhook_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def create_webhook_with_http_info( + self, + designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerWebhookWebhookDTO]: + """Create a webhook + + Create a new webhook with Visier. You must specify the webhook's endpoint URL, its active status, the event types to listen for, and the credentials to authenticate calls to the webhook endpoint.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param designer_webhook_webhook_request_dto: (required) + :type designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_webhook_serialize( + designer_webhook_webhook_request_dto=designer_webhook_webhook_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def create_webhook_without_preload_content( + self, + designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a webhook + + Create a new webhook with Visier. You must specify the webhook's endpoint URL, its active status, the event types to listen for, and the credentials to authenticate calls to the webhook endpoint.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param designer_webhook_webhook_request_dto: (required) + :type designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_webhook_serialize( + designer_webhook_webhook_request_dto=designer_webhook_webhook_request_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _create_webhook_serialize( + self, + designer_webhook_webhook_request_dto, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if designer_webhook_webhook_request_dto is not None: + _body_params = designer_webhook_webhook_request_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1beta/op/webhooks', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_webhook( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerWebhookWebhookDTO: + """Delete a webhook + + Delete a specific webhook. You must know the ID of the webhook to delete it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_webhook_serialize( + webhook_id=webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_webhook_with_http_info( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerWebhookWebhookDTO]: + """Delete a webhook + + Delete a specific webhook. You must know the ID of the webhook to delete it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_webhook_serialize( + webhook_id=webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_webhook_without_preload_content( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a webhook + + Delete a specific webhook. You must know the ID of the webhook to delete it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_webhook_serialize( + webhook_id=webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_webhook_serialize( + self, + webhook_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if webhook_id is not None: + _path_params['webhookId'] = webhook_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1beta/op/webhooks/{webhookId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def delete_webhook_credentials( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerWebhookWebhookDTO: + """Delete a webhook's credentials + + Delete the credentials for a webhook. You must know the ID of the webhook to delete its credentials. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_webhook_credentials_serialize( + webhook_id=webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_webhook_credentials_with_http_info( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerWebhookWebhookDTO]: + """Delete a webhook's credentials + + Delete the credentials for a webhook. You must know the ID of the webhook to delete its credentials. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_webhook_credentials_serialize( + webhook_id=webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_webhook_credentials_without_preload_content( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete a webhook's credentials + + Delete the credentials for a webhook. You must know the ID of the webhook to delete its credentials. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_webhook_credentials_serialize( + webhook_id=webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_webhook_credentials_serialize( + self, + webhook_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if webhook_id is not None: + _path_params['webhookId'] = webhook_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/v1beta/op/webhooks/{webhookId}/credentials', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_all_webhooks( + self, + event: Annotated[Optional[StrictStr], Field(description="Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.")] = None, + is_active: Annotated[Optional[StrictBool], Field(description="If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerWebhookWebhooksDTO: + """Retrieve a list of webhooks + + Retrieve a list of all webhooks. The response returns each webhook's definition, such as its endpoint URL, active status, and event types.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param event: Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks. + :type event: str + :param is_active: If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`. + :type is_active: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_webhooks_serialize( + event=event, + is_active=is_active, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhooksDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_all_webhooks_with_http_info( + self, + event: Annotated[Optional[StrictStr], Field(description="Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.")] = None, + is_active: Annotated[Optional[StrictBool], Field(description="If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerWebhookWebhooksDTO]: + """Retrieve a list of webhooks + + Retrieve a list of all webhooks. The response returns each webhook's definition, such as its endpoint URL, active status, and event types.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param event: Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks. + :type event: str + :param is_active: If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`. + :type is_active: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_webhooks_serialize( + event=event, + is_active=is_active, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhooksDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_all_webhooks_without_preload_content( + self, + event: Annotated[Optional[StrictStr], Field(description="Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.")] = None, + is_active: Annotated[Optional[StrictBool], Field(description="If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a list of webhooks + + Retrieve a list of all webhooks. The response returns each webhook's definition, such as its endpoint URL, active status, and event types.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param event: Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks. + :type event: str + :param is_active: If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`. + :type is_active: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_all_webhooks_serialize( + event=event, + is_active=is_active, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhooksDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_all_webhooks_serialize( + self, + event, + is_active, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if event is not None: + + _query_params.append(('event', event)) + + if is_active is not None: + + _query_params.append(('isActive', is_active)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1beta/op/webhooks', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_webhook( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerWebhookWebhookDTO: + """Retrieve a webhook's details + + Retrieve the details of a specific webhook. You must know the ID of the webhook to retrieve its details. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_webhook_serialize( + webhook_id=webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_webhook_with_http_info( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerWebhookWebhookDTO]: + """Retrieve a webhook's details + + Retrieve the details of a specific webhook. You must know the ID of the webhook to retrieve its details. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_webhook_serialize( + webhook_id=webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_webhook_without_preload_content( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a webhook's details + + Retrieve the details of a specific webhook. You must know the ID of the webhook to retrieve its details. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_webhook_serialize( + webhook_id=webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_webhook_serialize( + self, + webhook_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if webhook_id is not None: + _path_params['webhookId'] = webhook_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/v1beta/op/webhooks/{webhookId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def send_test_event( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerWebhookWebhookMessageResponseDTO: + """Test a webhook + + Send a test event to an existing webhook. This validates whether the webhook works. You must specify the webhook ID and an event type.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param designer_webhook_webhook_event_type_dto: (required) + :type designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._send_test_event_serialize( + webhook_id=webhook_id, + designer_webhook_webhook_event_type_dto=designer_webhook_webhook_event_type_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookMessageResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def send_test_event_with_http_info( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerWebhookWebhookMessageResponseDTO]: + """Test a webhook + + Send a test event to an existing webhook. This validates whether the webhook works. You must specify the webhook ID and an event type.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param designer_webhook_webhook_event_type_dto: (required) + :type designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._send_test_event_serialize( + webhook_id=webhook_id, + designer_webhook_webhook_event_type_dto=designer_webhook_webhook_event_type_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookMessageResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def send_test_event_without_preload_content( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test a webhook + + Send a test event to an existing webhook. This validates whether the webhook works. You must specify the webhook ID and an event type.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param designer_webhook_webhook_event_type_dto: (required) + :type designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._send_test_event_serialize( + webhook_id=webhook_id, + designer_webhook_webhook_event_type_dto=designer_webhook_webhook_event_type_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookMessageResponseDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _send_test_event_serialize( + self, + webhook_id, + designer_webhook_webhook_event_type_dto, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if webhook_id is not None: + _path_params['webhookId'] = webhook_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if designer_webhook_webhook_event_type_dto is not None: + _body_params = designer_webhook_webhook_event_type_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/v1beta/op/webhooks/{webhookId}/testEvent', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_webhook( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + designer_webhook_webhook_dto: DesignerWebhookWebhookDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerWebhookWebhookDTO: + """Update a webhook's details + + Update the details of an existing webhook, such as its URL and active status. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's credentials, see `PUT /v1beta/op/webhooks/{webhookId}/credentials`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param designer_webhook_webhook_dto: (required) + :type designer_webhook_webhook_dto: DesignerWebhookWebhookDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_webhook_serialize( + webhook_id=webhook_id, + designer_webhook_webhook_dto=designer_webhook_webhook_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_webhook_with_http_info( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + designer_webhook_webhook_dto: DesignerWebhookWebhookDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerWebhookWebhookDTO]: + """Update a webhook's details + + Update the details of an existing webhook, such as its URL and active status. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's credentials, see `PUT /v1beta/op/webhooks/{webhookId}/credentials`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param designer_webhook_webhook_dto: (required) + :type designer_webhook_webhook_dto: DesignerWebhookWebhookDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_webhook_serialize( + webhook_id=webhook_id, + designer_webhook_webhook_dto=designer_webhook_webhook_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_webhook_without_preload_content( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + designer_webhook_webhook_dto: DesignerWebhookWebhookDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update a webhook's details + + Update the details of an existing webhook, such as its URL and active status. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's credentials, see `PUT /v1beta/op/webhooks/{webhookId}/credentials`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param designer_webhook_webhook_dto: (required) + :type designer_webhook_webhook_dto: DesignerWebhookWebhookDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_webhook_serialize( + webhook_id=webhook_id, + designer_webhook_webhook_dto=designer_webhook_webhook_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_webhook_serialize( + self, + webhook_id, + designer_webhook_webhook_dto, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if webhook_id is not None: + _path_params['webhookId'] = webhook_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if designer_webhook_webhook_dto is not None: + _body_params = designer_webhook_webhook_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1beta/op/webhooks/{webhookId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_webhook_credentials( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DesignerWebhookWebhookDTO: + """Update a webhook's credentials + + Update the credentials to authenticate calls to the webhook endpoint. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's details, see `PUT /v1beta/op/webhooks/{webhookId}`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param designer_webhook_webhook_credentials_dto: (required) + :type designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_webhook_credentials_serialize( + webhook_id=webhook_id, + designer_webhook_webhook_credentials_dto=designer_webhook_webhook_credentials_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_webhook_credentials_with_http_info( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DesignerWebhookWebhookDTO]: + """Update a webhook's credentials + + Update the credentials to authenticate calls to the webhook endpoint. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's details, see `PUT /v1beta/op/webhooks/{webhookId}`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param designer_webhook_webhook_credentials_dto: (required) + :type designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_webhook_credentials_serialize( + webhook_id=webhook_id, + designer_webhook_webhook_credentials_dto=designer_webhook_webhook_credentials_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_webhook_credentials_without_preload_content( + self, + webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")], + designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update a webhook's credentials + + Update the credentials to authenticate calls to the webhook endpoint. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's details, see `PUT /v1beta/op/webhooks/{webhookId}`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values.
**Note:** This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM). + + :param webhook_id: The unique identifier of the webhook. (required) + :type webhook_id: str + :param designer_webhook_webhook_credentials_dto: (required) + :type designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_webhook_credentials_serialize( + webhook_id=webhook_id, + designer_webhook_webhook_credentials_dto=designer_webhook_webhook_credentials_dto, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DesignerWebhookWebhookDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_webhook_credentials_serialize( + self, + webhook_id, + designer_webhook_webhook_credentials_dto, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if webhook_id is not None: + _path_params['webhookId'] = webhook_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if designer_webhook_webhook_credentials_dto is not None: + _body_params = designer_webhook_webhook_credentials_dto + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'CookieAuth', + 'ApiKeyAuth', + 'OAuth2Auth', + 'OAuth2Auth', + 'BearerAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/v1beta/op/webhooks/{webhookId}/credentials', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/api_client.py b/src/visier_platform_sdk/visier_platform_sdk/api_client.py new file mode 100644 index 0000000000..a379c21679 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api_client.py @@ -0,0 +1,811 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import datetime +from dateutil.parser import parse +from enum import Enum +import decimal +import json +import mimetypes +import os +import re +import tempfile + +from urllib.parse import quote +from typing import Tuple, Optional, List, Dict, Union +from pydantic import SecretStr + +from visier_platform_sdk.configuration import Configuration +from visier_platform_sdk.api_response import ApiResponse, T as ApiResponseT +import visier_platform_sdk.models +from visier_platform_sdk import rest +from visier_platform_sdk.exceptions import ( + ApiValueError, + ApiException, + BadRequestException, + UnauthorizedException, + ForbiddenException, + NotFoundException, + ServiceException +) + +RequestSerialized = Tuple[str, str, Dict[str, str], Optional[str], List[str]] + +class ApiClient: + """Generic API client for use in custom API packages. + This client handles the client-server communication, and is invariant across implementations. + Specifics of the methods and models for each application are inside each API package. + + :param configuration: .Configuration object for this client + :param header_name: a header to pass when making calls to the API. + :param header_value: a header value to pass when making calls to + the API. + :param cookie: a cookie to include in the header when making calls + to the API + """ + + PRIMITIVE_TYPES = (float, bool, bytes, str, int) + NATIVE_TYPES_MAPPING = { + 'int': int, + 'long': int, # TODO remove as only py3 is supported? + 'float': float, + 'str': str, + 'bool': bool, + 'date': datetime.date, + 'datetime': datetime.datetime, + 'decimal': decimal.Decimal, + 'object': object, + } + _pool = None + + def __init__( + self, + configuration=None, + header_name=None, + header_value=None, + cookie=None, + auth_retries=2 + ) -> None: + # use default configuration if none is provided + if configuration is None: + configuration = Configuration.get_default() + self.configuration = configuration + + self.rest_client = rest.RESTClientObject(configuration) + self.default_headers = {} + if header_name is not None: + self.default_headers[header_name] = header_value + self.cookie = cookie + # Set default User-Agent. + self.user_agent = 'Visier-SDK/22222222.99201.1892.beta3/python' + self.client_side_validation = configuration.client_side_validation + self.auth_retries = auth_retries + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_value, traceback): + pass + + @property + def user_agent(self): + """User agent for this API client""" + return self.default_headers['User-Agent'] + + @user_agent.setter + def user_agent(self, value): + self.default_headers['User-Agent'] = value + + def set_default_header(self, header_name, header_value): + self.default_headers[header_name] = header_value + + + _default = None + + @classmethod + def get_default(cls): + """Return new instance of ApiClient. + + This method returns newly created, based on default constructor, + object of ApiClient class or returns a copy of default + ApiClient. + + :return: The ApiClient object. + """ + if cls._default is None: + cls._default = ApiClient() + return cls._default + + @classmethod + def set_default(cls, default): + """Set default instance of ApiClient. + + It stores default ApiClient. + + :param default: object of ApiClient. + """ + cls._default = default + + def param_serialize( + self, + method, + resource_path, + path_params=None, + query_params=None, + header_params=None, + body=None, + post_params=None, + files=None, auth_settings=None, + collection_formats=None, + _host=None, + _request_auth=None + ) -> RequestSerialized: + + """Builds the HTTP request params needed by the request. + :param method: Method to call. + :param resource_path: Path to method endpoint. + :param path_params: Path parameters in the url. + :param query_params: Query parameters in the url. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param auth_settings list: Auth Settings names for the request. + :param files dict: key -> filename, value -> filepath, + for `multipart/form-data`. + :param collection_formats: dict of collection formats for path, query, + header, and post parameters. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :return: tuple of form (path, http_method, query_params, header_params, + body, post_params, files) + """ + + config = self.configuration + + # header parameters + header_params = header_params or {} + for key, value in self.default_headers.items(): + header_params.setdefault(key, value) + if self.cookie: + header_params['Cookie'] = self.cookie + if header_params: + header_params = self.sanitize_for_serialization(header_params) + header_params = dict( + self.parameters_to_tuples(header_params,collection_formats) + ) + + # path parameters + if path_params: + path_params = self.sanitize_for_serialization(path_params) + path_params = self.parameters_to_tuples( + path_params, + collection_formats + ) + for k, v in path_params: + # specified safe chars, encode everything + resource_path = resource_path.replace( + '{%s}' % k, + quote(str(v), safe=config.safe_chars_for_path_param) + ) + + # post parameters + if post_params or files: + post_params = post_params if post_params else [] + post_params = self.sanitize_for_serialization(post_params) + post_params = self.parameters_to_tuples( + post_params, + collection_formats + ) + if files: + post_params.extend(self.files_parameters(files)) + + # auth setting + self.update_params_for_auth( + header_params, + query_params, + auth_settings, + resource_path, + method, + body, + request_auth=_request_auth + ) + + # body + if body: + body = self.sanitize_for_serialization(body) + + # request url + if _host is None or self.configuration.ignore_operation_servers: + url = self.configuration.host + resource_path + else: + # use server/host defined in path or operation instead + url = _host + resource_path + + # query parameters + if query_params: + query_params = self.sanitize_for_serialization(query_params) + url_query = self.parameters_to_url_query( + query_params, + collection_formats + ) + url += "?" + url_query + + return method, url, header_params, body, post_params + + + def call_api( + self, + method, + url, + header_params=None, + body=None, + post_params=None, + _request_timeout=None + ) -> rest.RESTResponse: + """Makes the HTTP request (synchronous) + :param method: Method to call. + :param url: Path to method endpoint. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param _request_timeout: timeout setting for this request. + :return: RESTResponse + """ + + attempt = 0 + while attempt < self.auth_retries: + # perform request and return response + response_data = self.rest_client.request( + method, url, + headers=header_params, + body=body, post_params=post_params, + _request_timeout=_request_timeout + ) + if response_data.status == 401: + if not self.configuration.refresh_config: + break + attempt += 1 + self.configuration.refresh_config(self.configuration, True) + self.update_params_for_auth(header_params, + post_params, + ['ApiKeyAuth', 'CookieAuth', 'OAuth2Auth'], + None, + None, + None + ) + continue + return response_data + + raise ApiException(f"Request failed after {self.auth_retries} retries") + + def response_deserialize( + self, + response_data: rest.RESTResponse, + response_types_map: Optional[Dict[str, ApiResponseT]]=None + ) -> ApiResponse[ApiResponseT]: + """Deserializes response into an object. + :param response_data: RESTResponse object to be deserialized. + :param response_types_map: dict of response types. + :return: ApiResponse + """ + + msg = "RESTResponse.read() must be called before passing it to response_deserialize()" + assert response_data.data is not None, msg + + response_type = response_types_map.get(str(response_data.status), None) + if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599: + # if not found, look for '1XX', '2XX', etc. + response_type = response_types_map.get(str(response_data.status)[0] + "XX", None) + + # deserialize response data + response_text = None + return_data = None + try: + if response_type == "bytearray": + return_data = response_data.data + elif response_type == "file": + return_data = self.__deserialize_file(response_data) + elif response_type is not None: + match = None + content_type = response_data.getheader('content-type') + if content_type is not None: + match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type) + encoding = match.group(1) if match else "utf-8" + response_text = response_data.data.decode(encoding) + return_data = self.deserialize(response_text, response_type, content_type) + finally: + if not 200 <= response_data.status <= 299: + raise ApiException.from_response( + http_resp=response_data, + body=response_text, + data=return_data, + ) + + return ApiResponse( + status_code = response_data.status, + data = return_data, + headers = response_data.getheaders(), + raw_data = response_data.data + ) + + def sanitize_for_serialization(self, obj): + """Builds a JSON POST object. + + If obj is None, return None. + If obj is SecretStr, return obj.get_secret_value() + If obj is str, int, long, float, bool, return directly. + If obj is datetime.datetime, datetime.date + convert to string in iso8601 format. + If obj is decimal.Decimal return string representation. + If obj is list, sanitize each element in the list. + If obj is dict, return the dict. + If obj is OpenAPI model, return the properties dict. + + :param obj: The data to serialize. + :return: The serialized form of data. + """ + if obj is None: + return None + elif isinstance(obj, Enum): + return obj.value + elif isinstance(obj, SecretStr): + return obj.get_secret_value() + elif isinstance(obj, self.PRIMITIVE_TYPES): + return obj + elif isinstance(obj, list): + return [ + self.sanitize_for_serialization(sub_obj) for sub_obj in obj + ] + elif isinstance(obj, tuple): + return tuple( + self.sanitize_for_serialization(sub_obj) for sub_obj in obj + ) + elif isinstance(obj, (datetime.datetime, datetime.date)): + return obj.isoformat() + elif isinstance(obj, decimal.Decimal): + return str(obj) + + elif isinstance(obj, dict): + obj_dict = obj + else: + # Convert model obj to dict except + # attributes `openapi_types`, `attribute_map` + # and attributes which value is not None. + # Convert attribute name to json key in + # model definition for request. + if hasattr(obj, 'to_dict') and callable(getattr(obj, 'to_dict')): + obj_dict = obj.to_dict() + else: + obj_dict = obj.__dict__ + + return { + key: self.sanitize_for_serialization(val) + for key, val in obj_dict.items() + } + + def deserialize(self, response_text: str, response_type: str, content_type: Optional[str]): + """Deserializes response into an object. + + :param response: RESTResponse object to be deserialized. + :param response_type: class literal for + deserialized object, or string of class name. + :param content_type: content type of response. + + :return: deserialized object. + """ + + # fetch data from response object + if content_type is None: + try: + data = json.loads(response_text) + except ValueError: + data = response_text + elif re.match(r'^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE): + if response_text == "": + data = "" + else: + data = json.loads(response_text) + elif re.match(r'^text\/[a-z.+-]+\s*(;|$)', content_type, re.IGNORECASE): + data = response_text + else: + raise ApiException( + status=0, + reason="Unsupported content type: {0}".format(content_type) + ) + + return self.__deserialize(data, response_type) + + def __deserialize(self, data, klass): + """Deserializes dict, list, str into an object. + + :param data: dict, list or str. + :param klass: class literal, or string of class name. + + :return: object. + """ + if data is None: + return None + + if isinstance(klass, str): + if klass.startswith('List['): + m = re.match(r'List\[(.*)]', klass) + assert m is not None, "Malformed List type definition" + sub_kls = m.group(1) + return [self.__deserialize(sub_data, sub_kls) + for sub_data in data] + + if klass.startswith('Dict['): + m = re.match(r'Dict\[([^,]*), (.*)]', klass) + assert m is not None, "Malformed Dict type definition" + sub_kls = m.group(2) + return {k: self.__deserialize(v, sub_kls) + for k, v in data.items()} + + # convert str to class + if klass in self.NATIVE_TYPES_MAPPING: + klass = self.NATIVE_TYPES_MAPPING[klass] + else: + klass = getattr(visier_platform_sdk.models, klass) + + if klass in self.PRIMITIVE_TYPES: + return self.__deserialize_primitive(data, klass) + elif klass == object: + return self.__deserialize_object(data) + elif klass == datetime.date: + return self.__deserialize_date(data) + elif klass == datetime.datetime: + return self.__deserialize_datetime(data) + elif klass == decimal.Decimal: + return decimal.Decimal(data) + elif issubclass(klass, Enum): + return self.__deserialize_enum(data, klass) + else: + return self.__deserialize_model(data, klass) + + def parameters_to_tuples(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: Parameters as list of tuples, collections formatted + """ + new_params: List[Tuple[str, str]] = [] + if collection_formats is None: + collection_formats = {} + for k, v in params.items() if isinstance(params, dict) else params: + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, value) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(str(value) for value in v))) + else: + new_params.append((k, v)) + return new_params + + def parameters_to_url_query(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: URL query string (e.g. a=Hello%20World&b=123) + """ + new_params: List[Tuple[str, str]] = [] + if collection_formats is None: + collection_formats = {} + for k, v in params.items() if isinstance(params, dict) else params: + if isinstance(v, bool): + v = str(v).lower() + if isinstance(v, (int, float)): + v = str(v) + if isinstance(v, dict): + v = json.dumps(v) + + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, quote(str(value))) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(quote(str(value)) for value in v)) + ) + else: + new_params.append((k, quote(str(v)))) + + return "&".join(["=".join(map(str, item)) for item in new_params]) + + def files_parameters( + self, + files: Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes]]], + ): + """Builds form parameters. + + :param files: File parameters. + :return: Form parameters with files. + """ + params = [] + for k, v in files.items(): + if isinstance(v, str): + with open(v, 'rb') as f: + filename = os.path.basename(f.name) + filedata = f.read() + elif isinstance(v, bytes): + filename = k + filedata = v + elif isinstance(v, tuple): + filename, filedata = v + elif isinstance(v, list): + for file_param in v: + params.extend(self.files_parameters({k: file_param})) + continue + else: + raise ValueError("Unsupported file value") + mimetype = ( + mimetypes.guess_type(filename)[0] + or 'application/octet-stream' + ) + params.append( + tuple([k, tuple([filename, filedata, mimetype])]) + ) + return params + + def select_header_accept(self, accepts: List[str]) -> Optional[str]: + """Returns `Accept` based on an array of accepts provided. + + :param accepts: List of headers. + :return: Accept (e.g. application/json). + """ + if not accepts: + return None + + for accept in accepts: + if re.search('json', accept, re.IGNORECASE): + return accept + + return accepts[0] + + def select_header_content_type(self, content_types): + """Returns `Content-Type` based on an array of content_types provided. + + :param content_types: List of content-types. + :return: Content-Type (e.g. application/json). + """ + if not content_types: + return None + + for content_type in content_types: + if re.search('json', content_type, re.IGNORECASE): + return content_type + + return content_types[0] + + def update_params_for_auth( + self, + headers, + queries, + auth_settings, + resource_path, + method, + body, + request_auth=None + ) -> None: + """Updates header and query params based on authentication setting. + + :param headers: Header parameters dict to be updated. + :param queries: Query parameters tuple list to be updated. + :param auth_settings: Authentication setting identifiers list. + :resource_path: A string representation of the HTTP request resource path. + :method: A string representation of the HTTP request method. + :body: A object representing the body of the HTTP request. + The object type is the return value of sanitize_for_serialization(). + :param request_auth: if set, the provided settings will + override the token in the configuration. + """ + if not auth_settings: + return + + if request_auth: + self._apply_auth_params( + headers, + queries, + resource_path, + method, + body, + request_auth + ) + else: + config_auth_settings = self.configuration.auth_settings() + for auth in auth_settings: + auth_setting = config_auth_settings.get(auth) + if auth_setting: + self._apply_auth_params( + headers, + queries, + resource_path, + method, + body, + auth_setting + ) + + def _apply_auth_params( + self, + headers, + queries, + resource_path, + method, + body, + auth_setting + ) -> None: + """Updates the request parameters based on a single auth_setting + + :param headers: Header parameters dict to be updated. + :param queries: Query parameters tuple list to be updated. + :resource_path: A string representation of the HTTP request resource path. + :method: A string representation of the HTTP request method. + :body: A object representing the body of the HTTP request. + The object type is the return value of sanitize_for_serialization(). + :param auth_setting: auth settings for the endpoint + """ + if auth_setting['in'] == 'cookie': + headers['Cookie'] = auth_setting['value'] + elif auth_setting['in'] == 'header': + if auth_setting['type'] != 'http-signature': + headers[auth_setting['key']] = auth_setting['value'] + elif auth_setting['in'] == 'query': + queries.append((auth_setting['key'], auth_setting['value'])) + else: + raise ApiValueError( + 'Authentication token must be in `query` or `header`' + ) + + def __deserialize_file(self, response): + """Deserializes body to file + + Saves response body into a file in a temporary folder, + using the filename from the `Content-Disposition` header if provided. + + handle file downloading + save response body into a tmp file and return the instance + + :param response: RESTResponse. + :return: file path. + """ + fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path) + os.close(fd) + os.remove(path) + + content_disposition = response.getheader("Content-Disposition") + if content_disposition: + m = re.search( + r'filename=[\'"]?([^\'"\s]+)[\'"]?', + content_disposition + ) + assert m is not None, "Unexpected 'content-disposition' header value" + filename = m.group(1) + path = os.path.join(os.path.dirname(path), filename) + + with open(path, "wb") as f: + f.write(response.data) + + return path + + def __deserialize_primitive(self, data, klass): + """Deserializes string to primitive type. + + :param data: str. + :param klass: class literal. + + :return: int, long, float, str, bool. + """ + try: + return klass(data) + except UnicodeEncodeError: + return str(data) + except TypeError: + return data + + def __deserialize_object(self, value): + """Return an original value. + + :return: object. + """ + return value + + def __deserialize_date(self, string): + """Deserializes string to date. + + :param string: str. + :return: date. + """ + try: + return parse(string).date() + except ImportError: + return string + except ValueError: + raise rest.ApiException( + status=0, + reason="Failed to parse `{0}` as date object".format(string) + ) + + def __deserialize_datetime(self, string): + """Deserializes string to datetime. + + The string should be in iso8601 datetime format. + + :param string: str. + :return: datetime. + """ + try: + return parse(string) + except ImportError: + return string + except ValueError: + raise rest.ApiException( + status=0, + reason=( + "Failed to parse `{0}` as datetime object" + .format(string) + ) + ) + + def __deserialize_enum(self, data, klass): + """Deserializes primitive type to enum. + + :param data: primitive type. + :param klass: class literal. + :return: enum value. + """ + try: + return klass(data) + except ValueError: + raise rest.ApiException( + status=0, + reason=( + "Failed to parse `{0}` as `{1}`" + .format(data, klass) + ) + ) + + def __deserialize_model(self, data, klass): + """Deserializes list or dict to model. + + :param data: dict, list. + :param klass: class literal. + :return: model object. + """ + + return klass.from_dict(data) diff --git a/src/visier_platform_sdk/visier_platform_sdk/api_response.py b/src/visier_platform_sdk/visier_platform_sdk/api_response.py new file mode 100644 index 0000000000..9bc7c11f6b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/api_response.py @@ -0,0 +1,21 @@ +"""API response object.""" + +from __future__ import annotations +from typing import Optional, Generic, Mapping, TypeVar +from pydantic import Field, StrictInt, StrictBytes, BaseModel + +T = TypeVar("T") + +class ApiResponse(BaseModel, Generic[T]): + """ + API response object + """ + + status_code: StrictInt = Field(description="HTTP status code") + headers: Optional[Mapping[str, str]] = Field(None, description="HTTP headers") + data: T = Field(description="Deserialized data given the data type") + raw_data: StrictBytes = Field(description="Raw data (HTTP response body)") + + model_config = { + "arbitrary_types_allowed": True + } diff --git a/src/visier_platform_sdk/visier_platform_sdk/configuration.py b/src/visier_platform_sdk/visier_platform_sdk/configuration.py new file mode 100644 index 0000000000..489e8bb916 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/configuration.py @@ -0,0 +1,808 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import copy +import http.client as httplib +import logging +from logging import FileHandler +import multiprocessing +import os +import secrets +import sys +import threading +import time +import webbrowser +from http import HTTPStatus +from logging import FileHandler +from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Union +from typing_extensions import NotRequired, Self + +from queue import Queue, Empty +from typing import Optional +from urllib.parse import urljoin, quote, urlparse, urlencode +from wsgiref.simple_server import make_server + +import urllib3 +from flask import Flask, request +from pydantic import BaseModel + +VISIER_USERNAME='VISIER_USERNAME' +VISIER_PASSWORD='VISIER_PASSWORD' +VISIER_APIKEY='VISIER_APIKEY' +VISIER_HOST='VISIER_HOST' +VISIER_VANITY='VISIER_VANITY' +VISIER_CLIENT_ID='VISIER_CLIENT_ID' +VISIER_CLIENT_SECRET='VISIER_CLIENT_SECRET' +VISIER_REDIRECT_URI='VISIER_REDIRECT_URI' +VISIER_TARGET_TENANT_ID='VISIER_TARGET_TENANT_ID' +VISIER_OAUTH_CALLBACK_URL='VISIER_OAUTH_CALLBACK_URL' + +JSON_SCHEMA_VALIDATION_KEYWORDS = { + 'multipleOf', 'maximum', 'exclusiveMaximum', + 'minimum', 'exclusiveMinimum', 'maxLength', + 'minLength', 'pattern', 'maxItems', 'minItems' +} + +class Configuration: + """This class contains various settings of the API client. + + :param host: Base url. + :param api_key: API key is necessary for all types of authentication. + :param username: Username for HTTP basic authentication. + :param password: Password for HTTP basic authentication. + :param client_id: Client ID for OAuth2 authentication. + :param client_secret: Client secret for OAuth2 authentication. + :param redirect_uri: Redirect URI for OAuth2 authentication. + :param vanity: Vanity name for Visier. + :param scope: Scope for OAuth2 authentication. + :param asid_token: ASID token for Visier. + :param access_token: Access token. + :param refresh_token: Refresh token. + :param token_expiration_secs: Token expiration time in seconds. + :param server_index: Index to servers configuration. + :param server_variables: Mapping with string values to replace variables in + templated server configuration. The validation of enums is performed for + variables with defined enum values before. + :param server_operation_index: Mapping from operation ID to an index to server + configuration. + :param server_operation_variables: Mapping from operation ID to a mapping with + string values to replace variables in templated server configuration. + The validation of enums is performed for variables with defined enum + values before. + :param ignore_operation_servers: Boolean to ignore operation servers. + :param ssl_ca_cert: Path to a file of concatenated CA certificates in PEM format. + :param retries: Number of retries for API requests. + :param debug: Boolean to enable or disable debug mode. + """ + + _default = None + + def __init__(self, + host=None, + api_key=None, + username=None, + password=None, + client_id=None, + client_secret=None, + redirect_uri=None, + vanity=None, + scope=None, + asid_token=None, + access_token=None, + refresh_token=None, + token_expiration_secs=3600, + server_index=None, + server_variables=None, + server_operation_index=None, + server_operation_variables=None, + ignore_operation_servers=False, + ssl_ca_cert=None, + retries=None, + ca_cert_data: Optional[Union[str, bytes]] = None, + *, + debug: Optional[bool] = None + ) -> None: + """Constructor + """ + self._base_path = "http://localhost" if host is None else host + """Default Base url + """ + # Authentication Settings + self.api_key = api_key + """API key is necessary for all types of authentication.""" + self.refresh_config = default_refresh_config + """function hook to refresh config (e.g. asid_token, access_token, refresh_token) + """ + self.username = username + """Username for HTTP basic authentication + """ + self.password = password + """Password for HTTP basic authentication + """ + self.client_id = client_id + """Client ID for OAuth2 authentication + """ + self.client_secret = client_secret + """Client Secret for OAuth2 authentication + """ + self.redirect_uri = redirect_uri + """Redirect URI for OAuth2 authentication + """ + self.vanity = vanity + """Vanity name for Visier + """ + self.scope = scope if scope else 'read' + """Scope for OAuth2 authentication + """ + self.asid_token = asid_token + """ASID token for Visier + """ + self.access_token = access_token + """Access token + """ + self.refresh_token = refresh_token + """Refresh token + """ + self.token_expiration_secs = token_expiration_secs + """Token expiration time in seconds + """ + self._token_acquired_at = None + """The time when the token was acquired last time + """ + self.server_index = 0 if server_index is None and host is None else server_index + self.server_operation_index = server_operation_index or {} + """Default server index + """ + self.server_variables = server_variables or {} + self.server_operation_variables = server_operation_variables or {} + """Default server variables + """ + self.ignore_operation_servers = ignore_operation_servers + """Ignore operation servers + """ + self.temp_folder_path = None + """Temp file folder for downloading files + """ + + + self.logger = {} + """Logging Settings + """ + self.logger["package_logger"] = logging.getLogger("visier_platform_sdk") + self.logger["urllib3_logger"] = logging.getLogger("urllib3") + self.logger_format = '%(asctime)s %(levelname)s %(message)s' + """Log format + """ + self.logger_stream_handler = None + """Log stream handler + """ + self.logger_file_handler: Optional[FileHandler] = None + """Log file handler + """ + self.logger_file = None + """Debug file location + """ + if debug is not None: + self.debug = debug + else: + self.__debug = False + """Debug switch + """ + + self.verify_ssl = True + """SSL/TLS verification + Set this to false to skip verifying SSL certificate when calling API + from https server. + """ + self.ssl_ca_cert = ssl_ca_cert + """Set this to customize the certificate file to verify the peer. + """ + self.ca_cert_data = ca_cert_data + """Set this to verify the peer using PEM (str) or DER (bytes) + certificate data. + """ + self.cert_file = None + """client certificate file + """ + self.key_file = None + """client key file + """ + self.assert_hostname = None + """Set this to True/False to enable/disable SSL hostname verification. + """ + self.tls_server_name = None + """SSL/TLS Server Name Indication (SNI) + Set this to the SNI value expected by the server. + """ + + self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 + """urllib3 connection pool's maximum number of connections saved + per pool. urllib3 uses 1 connection as default value, but this is + not the best value when you are making a lot of possibly parallel + requests to the same host, which is often the case here. + cpu_count * 5 is used as default value to increase performance. + """ + + self.proxy: Optional[str] = None + """Proxy URL + """ + self.proxy_headers = None + """Proxy headers + """ + self.safe_chars_for_path_param = '' + """Safe chars for path_param + """ + self.retries = retries + """Adding retries to override urllib3 default value 3 + """ + # Enable client side validation + self.client_side_validation = True + + self.socket_options = None + """Options to pass down to the underlying urllib3 socket + """ + + self.datetime_format = "%Y-%m-%dT%H:%M:%S.%f%z" + """datetime format + """ + + self.date_format = "%Y-%m-%d" + """date format + """ + + def __deepcopy__(self, memo): + cls = self.__class__ + result = cls.__new__(cls) + memo[id(self)] = result + for k, v in self.__dict__.items(): + if k not in ('logger', 'logger_file_handler'): + setattr(result, k, copy.deepcopy(v, memo)) + # shallow copy of loggers + result.logger = copy.copy(self.logger) + # use setters to configure loggers + result.logger_file = self.logger_file + result.debug = self.debug + return result + + def __setattr__(self, name: str, value: Any) -> None: + object.__setattr__(self, name, value) + + @classmethod + def set_default(cls, default: Optional[Self]) -> None: + """Set default instance of configuration. + + It stores default configuration, which can be + returned by get_default_copy method. + + :param default: object of Configuration + """ + cls._default = default + + @classmethod + def get_default(cls): + """Return the _default configuration. + If it is not set, it will be created using from_env method. + + :return: The configuration object. + """ + if cls._default is None: + cls._default = Configuration.from_env() + return cls._default + + @staticmethod + def from_dict(config_dict): + """Construct a new Configuration object from a dict. + + :param config_dict: A dictionary of parameters to construct a Configuration object. + :return: The configuration object. + """ + + return Configuration( + host=config_dict.get(VISIER_HOST), + api_key=config_dict.get(VISIER_APIKEY), + username=config_dict.get(VISIER_USERNAME), + password=config_dict.get(VISIER_PASSWORD), + client_id=config_dict.get(VISIER_CLIENT_ID), + client_secret=config_dict.get(VISIER_CLIENT_SECRET), + redirect_uri=config_dict.get(VISIER_REDIRECT_URI), + vanity=config_dict.get(VISIER_VANITY) + ) + + @staticmethod + def from_env(): + """Construct a new Configuration object from environment variables. + + :return: The configuration object. + """ + return Configuration( + host=os.getenv(VISIER_HOST), + api_key=os.getenv(VISIER_APIKEY), + username=os.getenv(VISIER_USERNAME), + password=os.getenv(VISIER_PASSWORD), + client_id=os.getenv(VISIER_CLIENT_ID), + client_secret=os.getenv(VISIER_CLIENT_SECRET), + redirect_uri=os.getenv(VISIER_REDIRECT_URI), + vanity=os.getenv(VISIER_VANITY) + ) + + @property + def logger_file(self) -> Optional[str]: + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + return self.__logger_file + + @logger_file.setter + def logger_file(self, value: Optional[str]) -> None: + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + self.__logger_file = value + if self.__logger_file: + # If set logging file, + # then add file handler and remove stream handler. + self.logger_file_handler = logging.FileHandler(self.__logger_file) + self.logger_file_handler.setFormatter(self.logger_formatter) + for _, logger in self.logger.items(): + logger.addHandler(self.logger_file_handler) + + @property + def debug(self) -> bool: + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + return self.__debug + + @debug.setter + def debug(self, value: bool) -> None: + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + self.__debug = value + if self.__debug: + # if debug status is True, turn on debug logging + for _, logger in self.logger.items(): + logger.setLevel(logging.DEBUG) + # turn on httplib debug + httplib.HTTPConnection.debuglevel = 1 + else: + # if debug status is False, turn off debug logging, + # setting log level to default `logging.WARNING` + for _, logger in self.logger.items(): + logger.setLevel(logging.WARNING) + # turn off httplib debug + httplib.HTTPConnection.debuglevel = 0 + + @property + def logger_format(self) -> str: + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + return self.__logger_format + + @logger_format.setter + def logger_format(self, value: str) -> None: + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + self.__logger_format = value + self.logger_formatter = logging.Formatter(self.__logger_format) + + def get_basic_auth_token(self): + """Gets HTTP basic authentication header (string). + + :return: The token for basic HTTP authentication. + """ + username = "" + if self.username is not None: + username = self.username + password = "" + if self.password is not None: + password = self.password + return urllib3.util.make_headers( + basic_auth=username + ':' + password + ).get('authorization') + + def auth_settings(self): + """Gets Auth Settings dict for api client. + + :return: The Auth Settings information dict. + """ + + if self.refresh_config: + self.refresh_config(self, False) + + # Necessary apiKey for all auth types + auth = {'ApiKeyAuth': { + 'type': 'api_key', + 'in': 'header', + 'key': 'apikey', + 'value': self.api_key + }} + + if self.asid_token: + auth['CookieAuth'] = { + 'type': 'api_key', + 'in': 'cookie', + 'key': 'VisierASIDToken', + 'value': f'VisierASIDToken={self.asid_token}' + } + + if self.access_token: + auth['OAuth2Auth'] = { + 'type': 'bearer', + 'in': 'header', + 'key': 'Authorization', + 'value': 'Bearer ' + self.access_token + } + return auth + + def to_debug_report(self): + """Gets the essential information for debugging. + + :return: The report for debugging. + """ + return "Python SDK Debug Report:\n"\ + "OS: {env}\n"\ + "Python Version: {pyversion}\n"\ + "Version of the API: 22222222.99201.1892\n"\ + "SDK Package Version: 22222222.99201.1892.beta3".\ + format(env=sys.platform, pyversion=sys.version) + + def get_host_settings(self): + """Gets an array of host settings + + :return: An array of host settings + """ + return [ + { + 'url': "", + 'description': "No description provided", + } + ] + + def get_host_from_settings(self, index, variables=None, servers=None): + """Gets host URL based on the index and variables + :param index: array index of the host settings + :param variables: hash of variable and the corresponding value + :param servers: an array of host settings or None + :return: URL based on host settings + """ + if index is None: + return self._base_path + + variables = {} if variables is None else variables + servers = self.get_host_settings() if servers is None else servers + + try: + server = servers[index] + except IndexError: + raise ValueError( + "Invalid index {0} when selecting the host settings. " + "Must be less than {1}".format(index, len(servers))) + + url = server['url'] + + # go through variables and replace placeholders + for variable_name, variable in server.get('variables', {}).items(): + used_value = variables.get( + variable_name, variable['default_value']) + + if 'enum_values' in variable \ + and used_value not in variable['enum_values']: + raise ValueError( + "The variable `{0}` in the host URL has invalid value " + "{1}. Must be {2}.".format( + variable_name, variables[variable_name], + variable['enum_values'])) + + url = url.replace("{" + variable_name + "}", used_value) + + return url + + @property + def host(self) -> str: + """Return generated host.""" + return self.get_host_from_settings(self.server_index, variables=self.server_variables) + + @host.setter + def host(self, value: str) -> None: + """Fix base path.""" + self._base_path = value + self.server_index = None + + @property + def access_token(self): + return self._access_token + + @access_token.setter + def access_token(self, value): + self._access_token = value + self._token_acquired_at = time.time() + + @property + def asid_token(self): + return self._asid_token + + @asid_token.setter + def asid_token(self, value): + self._asid_token = value + self._token_acquired_at = time.time() + + def is_token_expired(self): + # Not using token expiration logic + if self.token_expiration_secs is None: + return False + + # Token has not been acquired yet + if not self._token_acquired_at: + return True + + return time.time() - self._token_acquired_at > self.token_expiration_secs + +# Additional logic to handle authentication +######################################################################################################################## +ACCESS_TOKEN = 'access_token' +API_KEY = "apikey" +AUTHORIZATION_CODE = "authorization_code" +CLIENT_ID = "client_id" +CODE = "code" +CODE_CHALLENGE = "code_challenge" +CODE_CHALLENGE_METHOD = "code_challenge_method" +CODE_VERIFIER = "code_verifier" +GRANT_TYPE = "grant_type" +PASSWORD = "password" +REDIRECT_URI = "redirect_uri" +REFRESH_TOKEN = "refresh_token" +RESPONSE_TYPE = "response_type" +SCOPE = "scope" +USERNAME = "username" + +# Disable werkzeug logging for the callback server +logging.getLogger('werkzeug').disabled = True + +class CallbackServer: + """Callback server that listens for the OAuth2 authorization code""" + + def __init__(self, provided_url: str) -> None: + parsed_uri = urlparse(provided_url) + self.host = parsed_uri.hostname or "localhost" + self.port = parsed_uri.port or 5000 + self.path = parsed_uri.path or "/oauth2/callback" + + self.server = None + self.flask_thread = None + self.app = Flask(__name__) + self.app.route(self.path, methods=["GET"])(self.callback) + self.queue = Queue() + + def callback(self): + """The handler for the OAuth2 callback providing the auth code""" + code = request.args.get(CODE) + self.queue.put(code) + return "

You can now close this window

" + + def start(self): + """Starts the callback server""" + self.server = make_server(self.host, self.port, self.app) + self.flask_thread = threading.Thread(target=self.server.serve_forever) + self.flask_thread.start() + + def stop(self): + """Stops the callback server""" + if self.server: + self.server.shutdown() + self.flask_thread.join() + self.server = None + self.flask_thread = None + + def __enter__(self): + self.start() + return self + + def __exit__(self, ex_type, ex_value, trace_back): + self.stop() + + +class TokenRequestDTO(BaseModel): + grant_type: str + client_id: str + scope: str + username: str = None + password: str = None + code: str = None + code_verifier: str = None + redirect_uri: str = None + refresh_token: str = None + + +class TokenResponseDTO(BaseModel): + access_token: str + refresh_token: str + id_token: str + token_type: str + expires_in: int + + +http = urllib3.PoolManager() + + +def _post_request(url: str, data: dict, additional_headers: dict = None, auth=None): + headers = { + 'Accept': 'application/jsonlines, application/json', + 'User-Agent': 'OpenAPI-python', + 'Content-Type': 'application/x-www-form-urlencoded' + } + if additional_headers: + headers.update(additional_headers) + + if auth: + username, password = auth + auth_header = base64.b64encode(f"{username}:{password}".encode('utf-8')).decode('ascii') + headers['Authorization'] = f'Basic {auth_header}' + + response = http.request( + 'POST', + url, + body=urlencode(data), + headers=headers, + retries=False + ) + if response.status != HTTPStatus.OK: + raise ApiException.from_response( + http_resp=response, + body=None, + data=None + ) + + return response + + +def _connect_asid(config): + url = urljoin(config.host, '/v1/admin/visierSecureToken') + data = { + USERNAME: config.username, + PASSWORD: config.password + } + if config.vanity: + data["vanityName"] = config.vanity + response = _post_request(url=url, data=data) + config.asid_token = response.data.decode(('utf-8')) + + +def _update_access_token(config, token_request: TokenRequestDTO): + url = config.host + "/v1/auth/oauth2/token" + body = token_request.dict() + if config.redirect_uri: + body[REDIRECT_URI] = config.redirect_uri + auth = (config.client_id, quote(config.client_secret, safe='')) + headers = { + API_KEY: config.api_key, + } + + response = _post_request(url=url, data=body, additional_headers=headers, auth=auth) + tokenResponse = TokenResponseDTO(**response.json()) + config.access_token = tokenResponse.access_token + config.refresh_token = tokenResponse.refresh_token + config.token_expiration_secs = tokenResponse.expires_in + + +def _refresh_token(config): + token_request = TokenRequestDTO( + grant_type=REFRESH_TOKEN, + client_id=config.client_id, + scope=config.scope, + refresh_token=config.refresh_token + ) + _update_access_token(config, token_request) + + +def _connect_oauth_password(config): + token_request = TokenRequestDTO( + grant_type=PASSWORD, + client_id=config.client_id, + scope=config.scope, + username=config.username, + password=config.password + ) + _update_access_token(config, token_request) + + +def _connect_oauth_code(config): + """Connect to Visier using (three-legged) OAuth2.""" + code_verifier = secrets.token_urlsafe(64) + code_challenge_digest = hashlib.sha256(code_verifier.encode()).digest() + code_challenge = base64.urlsafe_b64encode(code_challenge_digest).decode().rstrip("=") + + url_prefix = config.host + "/v1/auth/oauth2" + svr = CallbackServer(config.redirect_uri) + query_args = { + API_KEY: config.api_key, + RESPONSE_TYPE: CODE, + CLIENT_ID: config.client_id, + CODE_CHALLENGE_METHOD: "S256", + CODE_CHALLENGE: code_challenge + } + if config.redirect_uri: + query_args[REDIRECT_URI] = config.redirect_uri + + browser_url = f'{url_prefix}/authorize?{urlencode(query_args)}' + webbrowser.open(browser_url) + try: + svr.start() + code = svr.queue.get(block=True, timeout=120) + token_request = TokenRequestDTO( + grant_type=AUTHORIZATION_CODE, + client_id=config.client_id, + scope=config.scope, + code=code, + code_verifier=code_verifier + ) + _update_access_token(config, token_request) + except Empty as empty: + raise ApiException("Timed out waiting for OAuth2 auth code") from empty + finally: + svr.stop() + + +def _connect_oauth(config): + if config.refresh_token: + _refresh_token(config) + elif config.username and config.password: + _connect_oauth_password(config) + else: + _connect_oauth_code(config) + + +def _need_to_connect(config): + if config.client_id and config.client_secret: + return not config.access_token or config.is_token_expired() + + if config.username and config.password: + return not config.asid_token or config.is_token_expired() + + raise ValueError("No valid authentication method found") + + +def default_refresh_config(config, force_refresh: bool = False): + if not force_refresh and not _need_to_connect(config): + return + + if config.client_id and config.client_secret: + _connect_oauth(config) + elif config.username and config.password: + _connect_asid(config) diff --git a/src/visier_platform_sdk/visier_platform_sdk/exceptions.py b/src/visier_platform_sdk/visier_platform_sdk/exceptions.py new file mode 100644 index 0000000000..9f41da70a0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/exceptions.py @@ -0,0 +1,217 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from typing import Any, Optional +from typing_extensions import Self + +class OpenApiException(Exception): + """The base exception class for all OpenAPIExceptions""" + + +class ApiTypeError(OpenApiException, TypeError): + def __init__(self, msg, path_to_item=None, valid_classes=None, + key_type=None) -> None: + """ Raises an exception for TypeErrors + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list): a list of keys an indices to get to the + current_item + None if unset + valid_classes (tuple): the primitive classes that current item + should be an instance of + None if unset + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + None if unset + """ + self.path_to_item = path_to_item + self.valid_classes = valid_classes + self.key_type = key_type + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiTypeError, self).__init__(full_msg) + + +class ApiValueError(OpenApiException, ValueError): + def __init__(self, msg, path_to_item=None) -> None: + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list) the path to the exception in the + received_data dict. None if unset + """ + + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiValueError, self).__init__(full_msg) + + +class ApiAttributeError(OpenApiException, AttributeError): + def __init__(self, msg, path_to_item=None) -> None: + """ + Raised when an attribute reference or assignment fails. + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiAttributeError, self).__init__(full_msg) + + +class ApiKeyError(OpenApiException, KeyError): + def __init__(self, msg, path_to_item=None) -> None: + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiKeyError, self).__init__(full_msg) + + +class ApiException(OpenApiException): + + def __init__( + self, + status=None, + reason=None, + http_resp=None, + *, + body: Optional[str] = None, + data: Optional[Any] = None, + ) -> None: + self.status = status + self.reason = reason + self.body = body + self.data = data + self.headers = None + + if http_resp: + if self.status is None: + self.status = http_resp.status + if self.reason is None: + self.reason = http_resp.reason + if self.body is None: + try: + self.body = http_resp.data.decode('utf-8') + except Exception: + pass + self.headers = http_resp.getheaders() + + @classmethod + def from_response( + cls, + *, + http_resp, + body: Optional[str], + data: Optional[Any], + ) -> Self: + if http_resp.status == 400: + raise BadRequestException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 401: + raise UnauthorizedException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 403: + raise ForbiddenException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 404: + raise NotFoundException(http_resp=http_resp, body=body, data=data) + + # Added new conditions for 409 and 422 + if http_resp.status == 409: + raise ConflictException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 422: + raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data) + + if 500 <= http_resp.status <= 599: + raise ServiceException(http_resp=http_resp, body=body, data=data) + raise ApiException(http_resp=http_resp, body=body, data=data) + + def __str__(self): + """Custom error messages for exception""" + error_message = "({0})\n"\ + "Reason: {1}\n".format(self.status, self.reason) + if self.headers: + error_message += "HTTP response headers: {0}\n".format( + self.headers) + + if self.data or self.body: + error_message += "HTTP response body: {0}\n".format(self.data or self.body) + + return error_message + + +class BadRequestException(ApiException): + pass + + +class NotFoundException(ApiException): + pass + + +class UnauthorizedException(ApiException): + pass + + +class ForbiddenException(ApiException): + pass + + +class ServiceException(ApiException): + pass + + +class ConflictException(ApiException): + """Exception for HTTP 409 Conflict.""" + pass + + +class UnprocessableEntityException(ApiException): + """Exception for HTTP 422 Unprocessable Entity.""" + pass + + +def render_path(path_to_item): + """Returns a string representation of a path""" + result = "" + for pth in path_to_item: + if isinstance(pth, int): + result += "[{0}]".format(pth) + else: + result += "['{0}']".format(pth) + return result diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/__init__.py b/src/visier_platform_sdk/visier_platform_sdk/models/__init__.py new file mode 100644 index 0000000000..9830ed4ba6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/__init__.py @@ -0,0 +1,630 @@ +# coding: utf-8 + +# flake8: noqa +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +# import models into model package +from visier_platform_sdk.models.admin_all_tenants_status_apidto import AdminAllTenantsStatusAPIDTO +from visier_platform_sdk.models.admin_assign_connector_credentials_by_tenant_response_dto import AdminAssignConnectorCredentialsByTenantResponseDTO +from visier_platform_sdk.models.admin_assign_connector_credentials_response_dto import AdminAssignConnectorCredentialsResponseDTO +from visier_platform_sdk.models.admin_assign_connector_with_credentials_response_dto import AdminAssignConnectorWithCredentialsResponseDTO +from visier_platform_sdk.models.admin_assigned_credential_info_response_dto import AdminAssignedCredentialInfoResponseDTO +from visier_platform_sdk.models.admin_batch_tenant_provision_apidto import AdminBatchTenantProvisionAPIDTO +from visier_platform_sdk.models.admin_business_location_dto import AdminBusinessLocationDTO +from visier_platform_sdk.models.admin_connector_info_response_dto import AdminConnectorInfoResponseDTO +from visier_platform_sdk.models.admin_connector_setting_request_dto import AdminConnectorSettingRequestDTO +from visier_platform_sdk.models.admin_connector_setting_response_dto import AdminConnectorSettingResponseDTO +from visier_platform_sdk.models.admin_connector_settings_response_dto import AdminConnectorSettingsResponseDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_excluded_source_list_dto import AdminConsolidatedAnalyticsAPIExcludedSourceListDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_source_tenant_list_dto import AdminConsolidatedAnalyticsAPISourceTenantListDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_create_request_dto import AdminConsolidatedAnalyticsAPITenantCreateRequestDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_list_response_dto import AdminConsolidatedAnalyticsAPITenantListResponseDTO +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_with_details import AdminConsolidatedAnalyticsAPITenantWithDetails +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_with_details_list_response_dto import AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO +from visier_platform_sdk.models.admin_custom_property_dto import AdminCustomPropertyDTO +from visier_platform_sdk.models.admin_custom_tenant_property_dto import AdminCustomTenantPropertyDTO +from visier_platform_sdk.models.admin_data_import_definition_apidto import AdminDataImportDefinitionAPIDTO +from visier_platform_sdk.models.admin_data_import_definitions_apidto import AdminDataImportDefinitionsAPIDTO +from visier_platform_sdk.models.admin_data_version_and_date_dto import AdminDataVersionAndDateDTO +from visier_platform_sdk.models.admin_delete_user_group_v2_request import AdminDeleteUserGroupV2Request +from visier_platform_sdk.models.admin_element_ids_dto import AdminElementIDsDTO +from visier_platform_sdk.models.admin_email_domains_dto import AdminEmailDomainsDTO +from visier_platform_sdk.models.admin_excluded_sources_body import AdminExcludedSourcesBody +from visier_platform_sdk.models.admin_extractor_setting_apidto import AdminExtractorSettingAPIDTO +from visier_platform_sdk.models.admin_extractor_setting_key_value_apidto import AdminExtractorSettingKeyValueAPIDTO +from visier_platform_sdk.models.admin_extractor_settings_apidto import AdminExtractorSettingsAPIDTO +from visier_platform_sdk.models.admin_home_analysis_by_user_group_dto import AdminHomeAnalysisByUserGroupDTO +from visier_platform_sdk.models.admin_jobs_consolidated_analytics_job_request_dto import AdminJobsConsolidatedAnalyticsJobRequestDTO +from visier_platform_sdk.models.admin_jobs_extract_data_and_load_dto import AdminJobsExtractDataAndLoadDTO +from visier_platform_sdk.models.admin_jobs_processing_job_request_dto import AdminJobsProcessingJobRequestDTO +from visier_platform_sdk.models.admin_key_name import AdminKeyName +from visier_platform_sdk.models.admin_mask_message import AdminMaskMessage +from visier_platform_sdk.models.admin_multiple_tenant_data_versions_details_dto import AdminMultipleTenantDataVersionsDetailsDTO +from visier_platform_sdk.models.admin_multiple_tenant_data_versions_list_dto import AdminMultipleTenantDataVersionsListDTO +from visier_platform_sdk.models.admin_network_subnets_message_request import AdminNetworkSubnetsMessageRequest +from visier_platform_sdk.models.admin_network_subnets_message_response import AdminNetworkSubnetsMessageResponse +from visier_platform_sdk.models.admin_permission_response_dto import AdminPermissionResponseDTO +from visier_platform_sdk.models.admin_permissions_list_dto import AdminPermissionsListDTO +from visier_platform_sdk.models.admin_permissions_to_user_group_for_tenant_dto import AdminPermissionsToUserGroupForTenantDTO +from visier_platform_sdk.models.admin_permissions_to_user_group_request_dto import AdminPermissionsToUserGroupRequestDTO +from visier_platform_sdk.models.admin_permissions_to_user_groups_request_dto import AdminPermissionsToUserGroupsRequestDTO +from visier_platform_sdk.models.admin_product_release_dto import AdminProductReleaseDTO +from visier_platform_sdk.models.admin_product_releases_dto import AdminProductReleasesDTO +from visier_platform_sdk.models.admin_product_version_dto import AdminProductVersionDTO +from visier_platform_sdk.models.admin_product_versions_dto import AdminProductVersionsDTO +from visier_platform_sdk.models.admin_product_versions_update_failure_tenant_response_dto import AdminProductVersionsUpdateFailureTenantResponseDTO +from visier_platform_sdk.models.admin_product_versions_update_response_dto import AdminProductVersionsUpdateResponseDTO +from visier_platform_sdk.models.admin_product_versions_update_successful_tenant_response_dto import AdminProductVersionsUpdateSuccessfulTenantResponseDTO +from visier_platform_sdk.models.admin_put_project_commits_request import AdminPutProjectCommitsRequest +from visier_platform_sdk.models.admin_security_assignment_response_dto import AdminSecurityAssignmentResponseDTO +from visier_platform_sdk.models.admin_set_connector_setting_request_dto import AdminSetConnectorSettingRequestDTO +from visier_platform_sdk.models.admin_set_connector_setting_response_dto import AdminSetConnectorSettingResponseDTO +from visier_platform_sdk.models.admin_set_connector_settings_request_dto import AdminSetConnectorSettingsRequestDTO +from visier_platform_sdk.models.admin_set_connector_settings_response_dto import AdminSetConnectorSettingsResponseDTO +from visier_platform_sdk.models.admin_simple_user_dto import AdminSimpleUserDTO +from visier_platform_sdk.models.admin_target_project_for_tenant_dto import AdminTargetProjectForTenantDTO +from visier_platform_sdk.models.admin_target_project_for_tenants_list_dto import AdminTargetProjectForTenantsListDTO +from visier_platform_sdk.models.admin_tenant_assignments_dto import AdminTenantAssignmentsDTO +from visier_platform_sdk.models.admin_tenant_code_body import AdminTenantCodeBody +from visier_platform_sdk.models.admin_tenant_connector_settings_request_dto import AdminTenantConnectorSettingsRequestDTO +from visier_platform_sdk.models.admin_tenant_detail_apidto import AdminTenantDetailAPIDTO +from visier_platform_sdk.models.admin_tenant_details_traits_dto import AdminTenantDetailsTraitsDTO +from visier_platform_sdk.models.admin_tenant_management_api_get_response_dto import AdminTenantManagementAPIGetResponseDTO +from visier_platform_sdk.models.admin_tenant_management_api_list_response_dto import AdminTenantManagementAPIListResponseDTO +from visier_platform_sdk.models.admin_tenant_management_api_update_request_dto import AdminTenantManagementAPIUpdateRequestDTO +from visier_platform_sdk.models.admin_tenant_management_api_update_response_dto import AdminTenantManagementAPIUpdateResponseDTO +from visier_platform_sdk.models.admin_tenant_provision_apidto import AdminTenantProvisionAPIDTO +from visier_platform_sdk.models.admin_tenant_status_apidto import AdminTenantStatusAPIDTO +from visier_platform_sdk.models.admin_update_tenant_model import AdminUpdateTenantModel +from visier_platform_sdk.models.admin_user_group_change_definition_dto import AdminUserGroupChangeDefinitionDTO +from visier_platform_sdk.models.admin_user_group_change_dimension_filter_dto import AdminUserGroupChangeDimensionFilterDTO +from visier_platform_sdk.models.admin_user_group_change_failure_dto import AdminUserGroupChangeFailureDTO +from visier_platform_sdk.models.admin_user_group_change_filter_dto import AdminUserGroupChangeFilterDTO +from visier_platform_sdk.models.admin_user_group_change_member_selection_dto import AdminUserGroupChangeMemberSelectionDTO +from visier_platform_sdk.models.admin_user_group_change_response_dto import AdminUserGroupChangeResponseDTO +from visier_platform_sdk.models.admin_user_group_change_success_dto import AdminUserGroupChangeSuccessDTO +from visier_platform_sdk.models.admin_user_group_change_users_dto import AdminUserGroupChangeUsersDTO +from visier_platform_sdk.models.admin_user_group_delete_dto import AdminUserGroupDeleteDTO +from visier_platform_sdk.models.admin_user_group_delete_failure_dto import AdminUserGroupDeleteFailureDTO +from visier_platform_sdk.models.admin_user_group_delete_response_dto import AdminUserGroupDeleteResponseDTO +from visier_platform_sdk.models.admin_user_group_delete_success_dto import AdminUserGroupDeleteSuccessDTO +from visier_platform_sdk.models.admin_user_group_filters_dto import AdminUserGroupFiltersDTO +from visier_platform_sdk.models.admin_user_group_get_api_response_dto import AdminUserGroupGetAPIResponseDTO +from visier_platform_sdk.models.admin_user_group_single_delete_response_dto import AdminUserGroupSingleDeleteResponseDTO +from visier_platform_sdk.models.admin_user_groups_change_dto import AdminUserGroupsChangeDTO +from visier_platform_sdk.models.admin_user_groups_delete_request_dto import AdminUserGroupsDeleteRequestDTO +from visier_platform_sdk.models.admin_user_groups_get_api_response_dto import AdminUserGroupsGetAPIResponseDTO +from visier_platform_sdk.models.admin_user_groups_users_dto import AdminUserGroupsUsersDTO +from visier_platform_sdk.models.admin_user_groups_users_for_tenant_dto import AdminUserGroupsUsersForTenantDTO +from visier_platform_sdk.models.admin_user_security_assignments_dto import AdminUserSecurityAssignmentsDTO +from visier_platform_sdk.models.admin_users_to_user_group_request_dto import AdminUsersToUserGroupRequestDTO +from visier_platform_sdk.models.admin_users_to_user_groups_request_dto import AdminUsersToUserGroupsRequestDTO +from visier_platform_sdk.models.analysis_common_report_create_request_dto import AnalysisCommonReportCreateRequestDTO +from visier_platform_sdk.models.analysis_common_report_dto import AnalysisCommonReportDTO +from visier_platform_sdk.models.analysis_common_report_delete_success_dto import AnalysisCommonReportDeleteSuccessDTO +from visier_platform_sdk.models.analysis_common_report_list_response_dto import AnalysisCommonReportListResponseDTO +from visier_platform_sdk.models.analysis_common_vee_clarification_dto import AnalysisCommonVeeClarificationDTO +from visier_platform_sdk.models.analysis_common_vee_conversation_state_dto import AnalysisCommonVeeConversationStateDTO +from visier_platform_sdk.models.analysis_common_vee_corrections_dto import AnalysisCommonVeeCorrectionsDTO +from visier_platform_sdk.models.analysis_common_vee_data_dto import AnalysisCommonVeeDataDTO +from visier_platform_sdk.models.analysis_common_vee_feedback_dto import AnalysisCommonVeeFeedbackDTO +from visier_platform_sdk.models.analysis_common_vee_options_dto import AnalysisCommonVeeOptionsDTO +from visier_platform_sdk.models.analysis_common_vee_question_dto import AnalysisCommonVeeQuestionDTO +from visier_platform_sdk.models.analysis_common_vee_response_dto import AnalysisCommonVeeResponseDTO +from visier_platform_sdk.models.analysis_common_vee_response_schema_dto import AnalysisCommonVeeResponseSchemaDTO +from visier_platform_sdk.models.analysis_common_vee_response_schema_reference_dto import AnalysisCommonVeeResponseSchemaReferenceDTO +from visier_platform_sdk.models.analysis_common_vee_sample_question_dto import AnalysisCommonVeeSampleQuestionDTO +from visier_platform_sdk.models.analysis_common_vee_sample_question_library_dto import AnalysisCommonVeeSampleQuestionLibraryDTO +from visier_platform_sdk.models.analysis_common_vee_status_code_dto import AnalysisCommonVeeStatusCodeDTO +from visier_platform_sdk.models.analysis_common_vee_visual_dto import AnalysisCommonVeeVisualDTO +from visier_platform_sdk.models.analysis_common_vee_visual_options_dto import AnalysisCommonVeeVisualOptionsDTO +from visier_platform_sdk.models.api_error import ApiError +from visier_platform_sdk.models.authentication_o_auth2_user_info_dto import AuthenticationOAuth2UserInfoDTO +from visier_platform_sdk.models.authentication_o_auth2_user_subnet_info_dto import AuthenticationOAuth2UserSubnetInfoDTO +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_detail_dto import AuthenticationOAuth2UserTenantDetailDTO +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_details_dto import AuthenticationOAuth2UserTenantDetailsDTO +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_properties_dto import AuthenticationOAuth2UserTenantPropertiesDTO +from visier_platform_sdk.models.benchmark_info import BenchmarkInfo +from visier_platform_sdk.models.benchmark_value import BenchmarkValue +from visier_platform_sdk.models.data_in_assign_connector_credential_request import DataInAssignConnectorCredentialRequest +from visier_platform_sdk.models.data_in_connector import DataInConnector +from visier_platform_sdk.models.data_in_data_load_request import DataInDataLoadRequest +from visier_platform_sdk.models.data_in_data_load_request_model import DataInDataLoadRequestModel +from visier_platform_sdk.models.data_in_data_load_response import DataInDataLoadResponse +from visier_platform_sdk.models.data_in_data_transfer_result_detail import DataInDataTransferResultDetail +from visier_platform_sdk.models.data_in_data_version_object import DataInDataVersionObject +from visier_platform_sdk.models.data_in_disable_dv_model import DataInDisableDVModel +from visier_platform_sdk.models.data_in_disable_dv_request import DataInDisableDVRequest +from visier_platform_sdk.models.data_in_disable_dv_response import DataInDisableDVResponse +from visier_platform_sdk.models.data_in_dispatching_job_status_response import DataInDispatchingJobStatusResponse +from visier_platform_sdk.models.data_in_exclude_data_uploads_request import DataInExcludeDataUploadsRequest +from visier_platform_sdk.models.data_in_extraction_job import DataInExtractionJob +from visier_platform_sdk.models.data_in_extraction_job_and_status_response import DataInExtractionJobAndStatusResponse +from visier_platform_sdk.models.data_in_include_data_uploads_request import DataInIncludeDataUploadsRequest +from visier_platform_sdk.models.data_in_job_status_list_response import DataInJobStatusListResponse +from visier_platform_sdk.models.data_in_job_status_with_start_time import DataInJobStatusWithStartTime +from visier_platform_sdk.models.data_in_processing_job import DataInProcessingJob +from visier_platform_sdk.models.data_in_processing_job_and_status_response import DataInProcessingJobAndStatusResponse +from visier_platform_sdk.models.data_in_processing_job_status_response import DataInProcessingJobStatusResponse +from visier_platform_sdk.models.data_in_push_data_cancel_response import DataInPushDataCancelResponse +from visier_platform_sdk.models.data_in_push_data_complete_request import DataInPushDataCompleteRequest +from visier_platform_sdk.models.data_in_push_data_complete_response import DataInPushDataCompleteResponse +from visier_platform_sdk.models.data_in_push_data_response import DataInPushDataResponse +from visier_platform_sdk.models.data_in_receiving_job import DataInReceivingJob +from visier_platform_sdk.models.data_in_receiving_job_and_status_response import DataInReceivingJobAndStatusResponse +from visier_platform_sdk.models.data_in_receiving_job_status_response import DataInReceivingJobStatusResponse +from visier_platform_sdk.models.data_in_result import DataInResult +from visier_platform_sdk.models.data_in_source import DataInSource +from visier_platform_sdk.models.data_in_start_extraction_response import DataInStartExtractionResponse +from visier_platform_sdk.models.data_in_start_transfer_response import DataInStartTransferResponse +from visier_platform_sdk.models.data_in_tenant import DataInTenant +from visier_platform_sdk.models.data_in_tenant_and_credential import DataInTenantAndCredential +from visier_platform_sdk.models.data_in_upload_to_exclude import DataInUploadToExclude +from visier_platform_sdk.models.data_in_upload_to_include import DataInUploadToInclude +from visier_platform_sdk.models.data_out_list_response import DataOutListResponse +from visier_platform_sdk.models.dataservices_common_dimension_member_reference_dto import DataservicesCommonDimensionMemberReferenceDTO +from visier_platform_sdk.models.dataservices_common_member_values_dto import DataservicesCommonMemberValuesDTO +from visier_platform_sdk.models.dataservices_datamodel_aggregation_type_option_dto import DataservicesDatamodelAggregationTypeOptionDTO +from visier_platform_sdk.models.dataservices_datamodel_aggregation_type_parameter_dto import DataservicesDatamodelAggregationTypeParameterDTO +from visier_platform_sdk.models.dataservices_datamodel_analytic_object_dto import DataservicesDatamodelAnalyticObjectDTO +from visier_platform_sdk.models.dataservices_datamodel_analytic_objects_dto import DataservicesDatamodelAnalyticObjectsDTO +from visier_platform_sdk.models.dataservices_datamodel_currencies_dto import DataservicesDatamodelCurrenciesDTO +from visier_platform_sdk.models.dataservices_datamodel_currency_dto import DataservicesDatamodelCurrencyDTO +from visier_platform_sdk.models.dataservices_datamodel_currency_rate_dto import DataservicesDatamodelCurrencyRateDTO +from visier_platform_sdk.models.dataservices_datamodel_currency_rates_dto import DataservicesDatamodelCurrencyRatesDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_dto import DataservicesDatamodelDimensionDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_mapping_validation_dto import DataservicesDatamodelDimensionMappingValidationDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_mapping_validation_execution_dto import DataservicesDatamodelDimensionMappingValidationExecutionDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_dimensions_dto import DataservicesDatamodelDimensionsDTO +from visier_platform_sdk.models.dataservices_datamodel_level_dto import DataservicesDatamodelLevelDTO +from visier_platform_sdk.models.dataservices_datamodel_member_dto import DataservicesDatamodelMemberDTO +from visier_platform_sdk.models.dataservices_datamodel_member_parameter_definition_dto import DataservicesDatamodelMemberParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_members_dto import DataservicesDatamodelMembersDTO +from visier_platform_sdk.models.dataservices_datamodel_metric_dto import DataservicesDatamodelMetricDTO +from visier_platform_sdk.models.dataservices_datamodel_metrics_dto import DataservicesDatamodelMetricsDTO +from visier_platform_sdk.models.dataservices_datamodel_numeric_parameter_definition_dto import DataservicesDatamodelNumericParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_object_reference_dto import DataservicesDatamodelObjectReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_parameter_definition_dto import DataservicesDatamodelParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_plan_parameter_definition_dto import DataservicesDatamodelPlanParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_concept_filter_context_dto import DataservicesDatamodelPlanningConceptFilterContextDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_hierarchy_filter_context_dto import DataservicesDatamodelPlanningHierarchyFilterContextDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_model_dto import DataservicesDatamodelPlanningModelDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_models_dto import DataservicesDatamodelPlanningModelsDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_plan_context_dto import DataservicesDatamodelPlanningPlanContextDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_plan_dto import DataservicesDatamodelPlanningPlanDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_plans_dto import DataservicesDatamodelPlanningPlansDTO +from visier_platform_sdk.models.dataservices_datamodel_population_configuration_dto import DataservicesDatamodelPopulationConfigurationDTO +from visier_platform_sdk.models.dataservices_datamodel_prediction_dto import DataservicesDatamodelPredictionDTO +from visier_platform_sdk.models.dataservices_datamodel_predictions_dto import DataservicesDatamodelPredictionsDTO +from visier_platform_sdk.models.dataservices_datamodel_properties_dto import DataservicesDatamodelPropertiesDTO +from visier_platform_sdk.models.dataservices_datamodel_property_dto import DataservicesDatamodelPropertyDTO +from visier_platform_sdk.models.dataservices_datamodel_property_reference_dto import DataservicesDatamodelPropertyReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_scenario_or_snapshot_dto import DataservicesDatamodelScenarioOrSnapshotDTO +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_dto import DataservicesDatamodelSelectionConceptDTO +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_reference_dto import DataservicesDatamodelSelectionConceptReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_selection_concepts_dto import DataservicesDatamodelSelectionConceptsDTO +from visier_platform_sdk.models.dataservices_datamodel_tag_map_element_dto import DataservicesDatamodelTagMapElementDTO +from visier_platform_sdk.models.dataservices_datamodel_validity_range_dto import DataservicesDatamodelValidityRangeDTO +from visier_platform_sdk.models.dataservices_query_aggregation_query_dto import DataservicesQueryAggregationQueryDTO +from visier_platform_sdk.models.dataservices_query_aggregation_query_execution_dto import DataservicesQueryAggregationQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_dto import DataservicesQueryAggregationQuerySourceDTO +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_metric_dto import DataservicesQueryAggregationQuerySourceMetricDTO +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_metrics_dto import DataservicesQueryAggregationQuerySourceMetricsDTO +from visier_platform_sdk.models.dataservices_query_aggregation_type_parameter_value_dto import DataservicesQueryAggregationTypeParameterValueDTO +from visier_platform_sdk.models.dataservices_query_cell_dto import DataservicesQueryCellDTO +from visier_platform_sdk.models.dataservices_query_cell_distribution_bin_dto import DataservicesQueryCellDistributionBinDTO +from visier_platform_sdk.models.dataservices_query_cell_distribution_options_dto import DataservicesQueryCellDistributionOptionsDTO +from visier_platform_sdk.models.dataservices_query_cell_set_axis_dto import DataservicesQueryCellSetAxisDTO +from visier_platform_sdk.models.dataservices_query_cell_set_axis_position_dto import DataservicesQueryCellSetAxisPositionDTO +from visier_platform_sdk.models.dataservices_query_cell_set_dto import DataservicesQueryCellSetDTO +from visier_platform_sdk.models.dataservices_query_cell_set_or_error_dto import DataservicesQueryCellSetOrErrorDTO +from visier_platform_sdk.models.dataservices_query_cohort_filter_dto import DataservicesQueryCohortFilterDTO +from visier_platform_sdk.models.dataservices_query_internal_query_execution_options_dto import DataservicesQueryInternalQueryExecutionOptionsDTO +from visier_platform_sdk.models.dataservices_query_key_group_filter_dto import DataservicesQueryKeyGroupFilterDTO +from visier_platform_sdk.models.dataservices_query_key_group_filter_item_dto import DataservicesQueryKeyGroupFilterItemDTO +from visier_platform_sdk.models.dataservices_query_lineage_dto import DataservicesQueryLineageDTO +from visier_platform_sdk.models.dataservices_query_list_query_execution_dto import DataservicesQueryListQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_list_query_execution_options_dto import DataservicesQueryListQueryExecutionOptionsDTO +from visier_platform_sdk.models.dataservices_query_list_query_source_dto import DataservicesQueryListQuerySourceDTO +from visier_platform_sdk.models.dataservices_query_member_filter_dto import DataservicesQueryMemberFilterDTO +from visier_platform_sdk.models.dataservices_query_member_parameter_value_dto import DataservicesQueryMemberParameterValueDTO +from visier_platform_sdk.models.dataservices_query_numeric_parameter_value_dto import DataservicesQueryNumericParameterValueDTO +from visier_platform_sdk.models.dataservices_query_plan_parameter_value_dto import DataservicesQueryPlanParameterValueDTO +from visier_platform_sdk.models.dataservices_query_property_column_dto import DataservicesQueryPropertyColumnDTO +from visier_platform_sdk.models.dataservices_query_query_axis_dto import DataservicesQueryQueryAxisDTO +from visier_platform_sdk.models.dataservices_query_query_axis_options_dto import DataservicesQueryQueryAxisOptionsDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_data_member_selection_dto import DataservicesQueryQueryDimensionDataMemberSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_leaf_selection_dto import DataservicesQueryQueryDimensionLeafSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_level_property_dto import DataservicesQueryQueryDimensionLevelPropertyDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_level_selection_dto import DataservicesQueryQueryDimensionLevelSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_member_selection_dto import DataservicesQueryQueryDimensionMemberSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_execution_error_dto import DataservicesQueryQueryExecutionErrorDTO +from visier_platform_sdk.models.dataservices_query_query_execution_error_details_dto import DataservicesQueryQueryExecutionErrorDetailsDTO +from visier_platform_sdk.models.dataservices_query_query_execution_errors_dto import DataservicesQueryQueryExecutionErrorsDTO +from visier_platform_sdk.models.dataservices_query_query_execution_options_dto import DataservicesQueryQueryExecutionOptionsDTO +from visier_platform_sdk.models.dataservices_query_query_filter_dto import DataservicesQueryQueryFilterDTO +from visier_platform_sdk.models.dataservices_query_query_member_map_property_dto import DataservicesQueryQueryMemberMapPropertyDTO +from visier_platform_sdk.models.dataservices_query_query_member_map_selection_dto import DataservicesQueryQueryMemberMapSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_numeric_ranges_dto import DataservicesQueryQueryNumericRangesDTO +from visier_platform_sdk.models.dataservices_query_query_parameter_value_dto import DataservicesQueryQueryParameterValueDTO +from visier_platform_sdk.models.dataservices_query_query_property_dto import DataservicesQueryQueryPropertyDTO +from visier_platform_sdk.models.dataservices_query_query_time_interval_dto import DataservicesQueryQueryTimeIntervalDTO +from visier_platform_sdk.models.dataservices_query_query_time_intervals_dto import DataservicesQueryQueryTimeIntervalsDTO +from visier_platform_sdk.models.dataservices_query_snapshot_query_execution_dto import DataservicesQuerySnapshotQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_snapshot_query_execution_options_dto import DataservicesQuerySnapshotQueryExecutionOptionsDTO +from visier_platform_sdk.models.dataservices_query_sort_option_dto import DataservicesQuerySortOptionDTO +from visier_platform_sdk.models.dataservices_query_sql_like_query_execution_dto import DataservicesQuerySqlLikeQueryExecutionDTO +from visier_platform_sdk.models.dataservices_query_time_shift_dto import DataservicesQueryTimeShiftDTO +from visier_platform_sdk.models.description_entry import DescriptionEntry +from visier_platform_sdk.models.designer_adp_auth_params_dto import DesignerAdpAuthParamsDTO +from visier_platform_sdk.models.designer_api_analytic_object_filter_dto import DesignerApiAnalyticObjectFilterDTO +from visier_platform_sdk.models.designer_api_calculation_concept_configuration_dto import DesignerApiCalculationConceptConfigurationDTO +from visier_platform_sdk.models.designer_api_calculation_concept_configuration_map_dto import DesignerApiCalculationConceptConfigurationMapDTO +from visier_platform_sdk.models.designer_api_calculation_concept_dto import DesignerApiCalculationConceptDTO +from visier_platform_sdk.models.designer_api_calculation_concept_list_dto import DesignerApiCalculationConceptListDTO +from visier_platform_sdk.models.designer_api_concept_configuration_result_dto import DesignerApiConceptConfigurationResultDTO +from visier_platform_sdk.models.designer_api_dimension_filter_dto import DesignerApiDimensionFilterDTO +from visier_platform_sdk.models.designer_api_dimension_member_dto import DesignerApiDimensionMemberDTO +from visier_platform_sdk.models.designer_api_perspective_configuration_dto import DesignerApiPerspectiveConfigurationDTO +from visier_platform_sdk.models.designer_api_perspective_node_dto import DesignerApiPerspectiveNodeDTO +from visier_platform_sdk.models.designer_api_selection_concept_configuration_dto import DesignerApiSelectionConceptConfigurationDTO +from visier_platform_sdk.models.designer_api_selection_concept_configuration_map_dto import DesignerApiSelectionConceptConfigurationMapDTO +from visier_platform_sdk.models.designer_api_selection_concept_dto import DesignerApiSelectionConceptDTO +from visier_platform_sdk.models.designer_api_selection_concept_list_dto import DesignerApiSelectionConceptListDTO +from visier_platform_sdk.models.designer_bamboo_auth_params_dto import DesignerBambooAuthParamsDTO +from visier_platform_sdk.models.designer_basic_s3_auth_params_dto import DesignerBasicS3AuthParamsDTO +from visier_platform_sdk.models.designer_big_query_auth_params_dto import DesignerBigQueryAuthParamsDTO +from visier_platform_sdk.models.designer_big_query_service_account_params_dto import DesignerBigQueryServiceAccountParamsDTO +from visier_platform_sdk.models.designer_copy_s3_auth_params_dto import DesignerCopyS3AuthParamsDTO +from visier_platform_sdk.models.designer_credential_creation_api_response_dto import DesignerCredentialCreationAPIResponseDTO +from visier_platform_sdk.models.designer_crypto_generate_key_request_dto import DesignerCryptoGenerateKeyRequestDTO +from visier_platform_sdk.models.designer_crypto_key_pair_delete_response_dto import DesignerCryptoKeyPairDeleteResponseDTO +from visier_platform_sdk.models.designer_crypto_key_pair_generate_request_dto import DesignerCryptoKeyPairGenerateRequestDTO +from visier_platform_sdk.models.designer_crypto_public_key_dto import DesignerCryptoPublicKeyDTO +from visier_platform_sdk.models.designer_crypto_public_keys_dto import DesignerCryptoPublicKeysDTO +from visier_platform_sdk.models.designer_crypto_tenant_encryption_key_dto import DesignerCryptoTenantEncryptionKeyDTO +from visier_platform_sdk.models.designer_crypto_tenant_encryption_key_details_dto import DesignerCryptoTenantEncryptionKeyDetailsDTO +from visier_platform_sdk.models.designer_data_provider_auth_information_dto import DesignerDataProviderAuthInformationDTO +from visier_platform_sdk.models.designer_data_provider_auth_params_dto import DesignerDataProviderAuthParamsDTO +from visier_platform_sdk.models.designer_data_provider_basic_information_dto import DesignerDataProviderBasicInformationDTO +from visier_platform_sdk.models.designer_data_provider_basic_metadata_dto import DesignerDataProviderBasicMetadataDTO +from visier_platform_sdk.models.designer_data_version_export_column_dto import DesignerDataVersionExportColumnDTO +from visier_platform_sdk.models.designer_data_version_export_dto import DesignerDataVersionExportDTO +from visier_platform_sdk.models.designer_data_version_export_data_version_summary_dto import DesignerDataVersionExportDataVersionSummaryDTO +from visier_platform_sdk.models.designer_data_version_export_data_versions_dto import DesignerDataVersionExportDataVersionsDTO +from visier_platform_sdk.models.designer_data_version_export_file_dto import DesignerDataVersionExportFileDTO +from visier_platform_sdk.models.designer_data_version_export_job_status_dto import DesignerDataVersionExportJobStatusDTO +from visier_platform_sdk.models.designer_data_version_export_part_file_dto import DesignerDataVersionExportPartFileDTO +from visier_platform_sdk.models.designer_data_version_export_schedule_job_request_dto import DesignerDataVersionExportScheduleJobRequestDTO +from visier_platform_sdk.models.designer_data_version_export_schedule_job_response_dto import DesignerDataVersionExportScheduleJobResponseDTO +from visier_platform_sdk.models.designer_data_version_export_table_dto import DesignerDataVersionExportTableDTO +from visier_platform_sdk.models.designer_data_version_exports_dto import DesignerDataVersionExportsDTO +from visier_platform_sdk.models.designer_databricks_auth_params_dto import DesignerDatabricksAuthParamsDTO +from visier_platform_sdk.models.designer_dayforce_v2_auth_params_dto import DesignerDayforceV2AuthParamsDTO +from visier_platform_sdk.models.designer_dimensions_auth_params_dto import DesignerDimensionsAuthParamsDTO +from visier_platform_sdk.models.designer_download_source_files_dto import DesignerDownloadSourceFilesDTO +from visier_platform_sdk.models.designer_download_source_files_response_dto import DesignerDownloadSourceFilesResponseDTO +from visier_platform_sdk.models.designer_extractor_credential_apidto import DesignerExtractorCredentialAPIDTO +from visier_platform_sdk.models.designer_extractor_credentials_apidto import DesignerExtractorCredentialsAPIDTO +from visier_platform_sdk.models.designer_fusion_auth_params_dto import DesignerFusionAuthParamsDTO +from visier_platform_sdk.models.designer_gong_auth_params_dto import DesignerGongAuthParamsDTO +from visier_platform_sdk.models.designer_google_sheets_auth_params_dto import DesignerGoogleSheetsAuthParamsDTO +from visier_platform_sdk.models.designer_google_workspace_auth_params_dto import DesignerGoogleWorkspaceAuthParamsDTO +from visier_platform_sdk.models.designer_greenhouse_auth_params_dto import DesignerGreenhouseAuthParamsDTO +from visier_platform_sdk.models.designer_icims_auth_params_dto import DesignerIcimsAuthParamsDTO +from visier_platform_sdk.models.designer_internal_s3_auth_params_dto import DesignerInternalS3AuthParamsDTO +from visier_platform_sdk.models.designer_jdbc_auth_params_dto import DesignerJdbcAuthParamsDTO +from visier_platform_sdk.models.designer_jira_auth_params_dto import DesignerJiraAuthParamsDTO +from visier_platform_sdk.models.designer_jira_connect_params_dto import DesignerJiraConnectParamsDTO +from visier_platform_sdk.models.designer_lever_auth_params_dto import DesignerLeverAuthParamsDTO +from visier_platform_sdk.models.designer_medallia_auth_params_dto import DesignerMedalliaAuthParamsDTO +from visier_platform_sdk.models.designer_microsoft365_auth_params_dto import DesignerMicrosoft365AuthParamsDTO +from visier_platform_sdk.models.designer_module_settings_dto import DesignerModuleSettingsDTO +from visier_platform_sdk.models.designer_my_sql_auth_params_dto import DesignerMySqlAuthParamsDTO +from visier_platform_sdk.models.designer_namely_auth_params_dto import DesignerNamelyAuthParamsDTO +from visier_platform_sdk.models.designer_oracle_db_auth_params_dto import DesignerOracleDbAuthParamsDTO +from visier_platform_sdk.models.designer_push_data_column_definition_dto import DesignerPushDataColumnDefinitionDTO +from visier_platform_sdk.models.designer_push_data_source_definition_dto import DesignerPushDataSourceDefinitionDTO +from visier_platform_sdk.models.designer_push_data_source_definitions_dto import DesignerPushDataSourceDefinitionsDTO +from visier_platform_sdk.models.designer_qualtrics_auth_params_dto import DesignerQualtricsAuthParamsDTO +from visier_platform_sdk.models.designer_redshift_auth_params_dto import DesignerRedshiftAuthParamsDTO +from visier_platform_sdk.models.designer_salesforce_auth_params_dto import DesignerSalesforceAuthParamsDTO +from visier_platform_sdk.models.designer_salesforce_v2_auth_params_dto import DesignerSalesforceV2AuthParamsDTO +from visier_platform_sdk.models.designer_service_now_auth_params_dto import DesignerServiceNowAuthParamsDTO +from visier_platform_sdk.models.designer_service_now_v2_auth_params_dto import DesignerServiceNowV2AuthParamsDTO +from visier_platform_sdk.models.designer_slack_auth_params_dto import DesignerSlackAuthParamsDTO +from visier_platform_sdk.models.designer_snowflake_auth_params_dto import DesignerSnowflakeAuthParamsDTO +from visier_platform_sdk.models.designer_sql_server_auth_params_dto import DesignerSqlServerAuthParamsDTO +from visier_platform_sdk.models.designer_subject_missing_access_dto import DesignerSubjectMissingAccessDTO +from visier_platform_sdk.models.designer_success_factors_auth_params_dto import DesignerSuccessFactorsAuthParamsDTO +from visier_platform_sdk.models.designer_success_factors_o_auth_params_dto import DesignerSuccessFactorsOAuthParamsDTO +from visier_platform_sdk.models.designer_tenant_module_dto import DesignerTenantModuleDTO +from visier_platform_sdk.models.designer_ultimate_auth_params_dto import DesignerUltimateAuthParamsDTO +from visier_platform_sdk.models.designer_webhook_webhook_basic_auth_credential_dto import DesignerWebhookWebhookBasicAuthCredentialDTO +from visier_platform_sdk.models.designer_webhook_webhook_credentials_dto import DesignerWebhookWebhookCredentialsDTO +from visier_platform_sdk.models.designer_webhook_webhook_dto import DesignerWebhookWebhookDTO +from visier_platform_sdk.models.designer_webhook_webhook_details_dto import DesignerWebhookWebhookDetailsDTO +from visier_platform_sdk.models.designer_webhook_webhook_event_type_dto import DesignerWebhookWebhookEventTypeDTO +from visier_platform_sdk.models.designer_webhook_webhook_message_response_dto import DesignerWebhookWebhookMessageResponseDTO +from visier_platform_sdk.models.designer_webhook_webhook_request_dto import DesignerWebhookWebhookRequestDTO +from visier_platform_sdk.models.designer_webhook_webhooks_dto import DesignerWebhookWebhooksDTO +from visier_platform_sdk.models.designer_willow_auth_params_dto import DesignerWillowAuthParamsDTO +from visier_platform_sdk.models.designer_workday_auth_params_dto import DesignerWorkdayAuthParamsDTO +from visier_platform_sdk.models.designer_workday_o_auth_params_dto import DesignerWorkdayOAuthParamsDTO +from visier_platform_sdk.models.designer_workday_raas_auth_params_dto import DesignerWorkdayRaasAuthParamsDTO +from visier_platform_sdk.models.designer_workday_refresh_token_params_dto import DesignerWorkdayRefreshTokenParamsDTO +from visier_platform_sdk.models.designer_zoom_auth_params_dto import DesignerZoomAuthParamsDTO +from visier_platform_sdk.models.dimension_member import DimensionMember +from visier_platform_sdk.models.direct_data_upload_file_response_dto import DirectDataUploadFileResponseDTO +from visier_platform_sdk.models.dp_automation_metric_validation_summary_dto import DpAutomationMetricValidationSummaryDTO +from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_dto import DpAutomationTenantPreviewEntriesSummaryDTO +from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_list_dto import DpAutomationTenantPreviewEntriesSummaryListDTO +from visier_platform_sdk.models.dp_cancel_job_batch_from_job_id_dto import DpCancelJobBatchFromJobIdDTO +from visier_platform_sdk.models.dp_job_cancellation_result_dto import DpJobCancellationResultDTO +from visier_platform_sdk.models.dp_job_cancellation_results_dto import DpJobCancellationResultsDTO +from visier_platform_sdk.models.dv_export_status import DvExportStatus +from visier_platform_sdk.models.extracted_skill import ExtractedSkill +from visier_platform_sdk.models.generate_impersonation_token_request import GenerateImpersonationTokenRequest +from visier_platform_sdk.models.google_protobuf_any import GoogleProtobufAny +from visier_platform_sdk.models.hierarchy import Hierarchy +from visier_platform_sdk.models.job import Job +from visier_platform_sdk.models.job_entry import JobEntry +from visier_platform_sdk.models.job_feedback_input import JobFeedbackInput +from visier_platform_sdk.models.job_search_failure_output import JobSearchFailureOutput +from visier_platform_sdk.models.job_search_input import JobSearchInput +from visier_platform_sdk.models.job_search_output import JobSearchOutput +from visier_platform_sdk.models.job_standardization_input import JobStandardizationInput +from visier_platform_sdk.models.job_standardization_input_skills import JobStandardizationInputSkills +from visier_platform_sdk.models.location_search_failure_output import LocationSearchFailureOutput +from visier_platform_sdk.models.location_search_input import LocationSearchInput +from visier_platform_sdk.models.location_search_input1 import LocationSearchInput1 +from visier_platform_sdk.models.location_search_output import LocationSearchOutput +from visier_platform_sdk.models.location_search_successful_output import LocationSearchSuccessfulOutput +from visier_platform_sdk.models.output_entry import OutputEntry +from visier_platform_sdk.models.output_entry1 import OutputEntry1 +from visier_platform_sdk.models.output_entry1_matches_inner import OutputEntry1MatchesInner +from visier_platform_sdk.models.plan_data_load_change_dto import PlanDataLoadChangeDTO +from visier_platform_sdk.models.plan_data_load_change_list_dto import PlanDataLoadChangeListDTO +from visier_platform_sdk.models.plan_data_upload_response_dto import PlanDataUploadResponseDTO +from visier_platform_sdk.models.plan_row_data_load_response_dto import PlanRowDataLoadResponseDTO +from visier_platform_sdk.models.planning_get_plan_list_response_dto import PlanningGetPlanListResponseDTO +from visier_platform_sdk.models.planning_plan_data_load_error_dto import PlanningPlanDataLoadErrorDTO +from visier_platform_sdk.models.planning_plan_info_dto import PlanningPlanInfoDTO +from visier_platform_sdk.models.planning_plan_item_dto import PlanningPlanItemDTO +from visier_platform_sdk.models.planning_plan_schema_dto import PlanningPlanSchemaDTO +from visier_platform_sdk.models.planning_plan_segment_level_dto import PlanningPlanSegmentLevelDTO +from visier_platform_sdk.models.planning_plan_segment_level_member_dto import PlanningPlanSegmentLevelMemberDTO +from visier_platform_sdk.models.planning_plan_segment_level_member_list_dto import PlanningPlanSegmentLevelMemberListDTO +from visier_platform_sdk.models.planning_plan_time_period_dto import PlanningPlanTimePeriodDTO +from visier_platform_sdk.models.planning_plan_with_schema_dto import PlanningPlanWithSchemaDTO +from visier_platform_sdk.models.planning_scenario_info_dto import PlanningScenarioInfoDTO +from visier_platform_sdk.models.salary_benchmark_input import SalaryBenchmarkInput +from visier_platform_sdk.models.salary_benchmarks_batch_processing_failure_output import SalaryBenchmarksBatchProcessingFailureOutput +from visier_platform_sdk.models.salary_benchmarks_batch_processing_outputs import SalaryBenchmarksBatchProcessingOutputs +from visier_platform_sdk.models.salary_benchmarks_batch_processing_successful_output import SalaryBenchmarksBatchProcessingSuccessfulOutput +from visier_platform_sdk.models.servicing_accessible_tenant_profile_assignment_request_dto import ServicingAccessibleTenantProfileAssignmentRequestDTO +from visier_platform_sdk.models.servicing_accessible_tenant_profile_assignment_response_dto import ServicingAccessibleTenantProfileAssignmentResponseDTO +from visier_platform_sdk.models.servicing_accessible_tenant_profile_revoke_request_dto import ServicingAccessibleTenantProfileRevokeRequestDTO +from visier_platform_sdk.models.servicing_accessible_tenant_profile_revoke_response_dto import ServicingAccessibleTenantProfileRevokeResponseDTO +from visier_platform_sdk.models.servicing_additional_capabilities_dto import ServicingAdditionalCapabilitiesDTO +from visier_platform_sdk.models.servicing_admin_capability_config_dto import ServicingAdminCapabilityConfigDTO +from visier_platform_sdk.models.servicing_all_permissions_assigned_for_local_tenant_dto import ServicingAllPermissionsAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_all_profile_assigned_for_accessible_tenant_dto import ServicingAllProfileAssignedForAccessibleTenantDTO +from visier_platform_sdk.models.servicing_all_profile_assigned_for_local_tenant_dto import ServicingAllProfileAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_all_user_groups_assigned_for_local_tenant_dto import ServicingAllUserGroupsAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_all_users_get_api_response_dto import ServicingAllUsersGetAPIResponseDTO +from visier_platform_sdk.models.servicing_analytic_object_dto import ServicingAnalyticObjectDTO +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_permission_dto import ServicingAssignRevokePermissionByPermissionDTO +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_tenant_dto import ServicingAssignRevokePermissionByTenantDTO +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_user_dto import ServicingAssignRevokePermissionByUserDTO +from visier_platform_sdk.models.servicing_assign_revoke_permission_request_dto import ServicingAssignRevokePermissionRequestDTO +from visier_platform_sdk.models.servicing_assign_revoke_permissions_request_dto import ServicingAssignRevokePermissionsRequestDTO +from visier_platform_sdk.models.servicing_assign_revoke_permissions_response_dto import ServicingAssignRevokePermissionsResponseDTO +from visier_platform_sdk.models.servicing_bulk_data_access_set_response_dto import ServicingBulkDataAccessSetResponseDTO +from visier_platform_sdk.models.servicing_capabilities_dto import ServicingCapabilitiesDTO +from visier_platform_sdk.models.servicing_capability_dto import ServicingCapabilityDTO +from visier_platform_sdk.models.servicing_capability_group_dto import ServicingCapabilityGroupDTO +from visier_platform_sdk.models.servicing_commit_and_publish_operation_response_dto import ServicingCommitAndPublishOperationResponseDTO +from visier_platform_sdk.models.servicing_commit_dto import ServicingCommitDTO +from visier_platform_sdk.models.servicing_content_package_dto import ServicingContentPackageDTO +from visier_platform_sdk.models.servicing_create_data_access_set_request_dto import ServicingCreateDataAccessSetRequestDTO +from visier_platform_sdk.models.servicing_data_access_set_dto import ServicingDataAccessSetDTO +from visier_platform_sdk.models.servicing_data_access_set_error_dto import ServicingDataAccessSetErrorDTO +from visier_platform_sdk.models.servicing_data_access_set_failure_dto import ServicingDataAccessSetFailureDTO +from visier_platform_sdk.models.servicing_data_access_set_success_dto import ServicingDataAccessSetSuccessDTO +from visier_platform_sdk.models.servicing_data_categories_response_dto import ServicingDataCategoriesResponseDTO +from visier_platform_sdk.models.servicing_data_category_response_dto import ServicingDataCategoryResponseDTO +from visier_platform_sdk.models.servicing_data_security_profile_dto import ServicingDataSecurityProfileDTO +from visier_platform_sdk.models.servicing_delete_permissions_request_dto import ServicingDeletePermissionsRequestDTO +from visier_platform_sdk.models.servicing_dimension_filter_dto import ServicingDimensionFilterDTO +from visier_platform_sdk.models.servicing_direct_data_job_config_dto import ServicingDirectDataJobConfigDTO +from visier_platform_sdk.models.servicing_direct_data_job_status_response_dto import ServicingDirectDataJobStatusResponseDTO +from visier_platform_sdk.models.servicing_direct_data_list_transactions_response_dto import ServicingDirectDataListTransactionsResponseDTO +from visier_platform_sdk.models.servicing_direct_data_load_config_dto import ServicingDirectDataLoadConfigDTO +from visier_platform_sdk.models.servicing_direct_data_schema_dto import ServicingDirectDataSchemaDTO +from visier_platform_sdk.models.servicing_direct_data_schema_field_dto import ServicingDirectDataSchemaFieldDTO +from visier_platform_sdk.models.servicing_direct_data_transaction_dto import ServicingDirectDataTransactionDTO +from visier_platform_sdk.models.servicing_direct_data_transaction_start_response_dto import ServicingDirectDataTransactionStartResponseDTO +from visier_platform_sdk.models.servicing_direct_data_upload_file_response_dto import ServicingDirectDataUploadFileResponseDTO +from visier_platform_sdk.models.servicing_document_search_link_dto import ServicingDocumentSearchLinkDTO +from visier_platform_sdk.models.servicing_dynamic_dimension_filter_dto import ServicingDynamicDimensionFilterDTO +from visier_platform_sdk.models.servicing_dynamic_property_mapping_dto import ServicingDynamicPropertyMappingDTO +from visier_platform_sdk.models.servicing_error_dto import ServicingErrorDTO +from visier_platform_sdk.models.servicing_export_production_versions_api_operation_parameters_dto import ServicingExportProductionVersionsAPIOperationParametersDTO +from visier_platform_sdk.models.servicing_failed_accessible_tenant_profile_assignment_dto import ServicingFailedAccessibleTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_failed_local_tenant_profile_assignment_dto import ServicingFailedLocalTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_failed_local_tenant_profile_revoke_dto import ServicingFailedLocalTenantProfileRevokeDTO +from visier_platform_sdk.models.servicing_get_capabilities_api_response_dto import ServicingGetCapabilitiesAPIResponseDTO +from visier_platform_sdk.models.servicing_get_content_packages_api_response_dto import ServicingGetContentPackagesAPIResponseDTO +from visier_platform_sdk.models.servicing_get_data_access_sets_api_response_dto import ServicingGetDataAccessSetsAPIResponseDTO +from visier_platform_sdk.models.servicing_get_data_security_objects_api_response_dto import ServicingGetDataSecurityObjectsAPIResponseDTO +from visier_platform_sdk.models.servicing_get_permissions_api_response_dto import ServicingGetPermissionsAPIResponseDTO +from visier_platform_sdk.models.servicing_get_production_versions_api_response_dto import ServicingGetProductionVersionsAPIResponseDTO +from visier_platform_sdk.models.servicing_get_projects_api_response_dto import ServicingGetProjectsAPIResponseDTO +from visier_platform_sdk.models.servicing_hierarchy_property_dto import ServicingHierarchyPropertyDTO +from visier_platform_sdk.models.servicing_inherited_access_config_dto import ServicingInheritedAccessConfigDTO +from visier_platform_sdk.models.servicing_inherited_reference_member_filter_config_dto import ServicingInheritedReferenceMemberFilterConfigDTO +from visier_platform_sdk.models.servicing_job_id_response import ServicingJobIdResponse +from visier_platform_sdk.models.servicing_last_login_dto import ServicingLastLoginDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_assignment_request_dto import ServicingLocalTenantProfileAssignmentRequestDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_assignment_response_dto import ServicingLocalTenantProfileAssignmentResponseDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_revoke_request_dto import ServicingLocalTenantProfileRevokeRequestDTO +from visier_platform_sdk.models.servicing_local_tenant_profile_revoke_response_dto import ServicingLocalTenantProfileRevokeResponseDTO +from visier_platform_sdk.models.servicing_member_filter_config_dto import ServicingMemberFilterConfigDTO +from visier_platform_sdk.models.servicing_member_selection_dto import ServicingMemberSelectionDTO +from visier_platform_sdk.models.servicing_objectconfiguration_calculated_property_type_dto import ServicingObjectconfigurationCalculatedPropertyTypeDTO +from visier_platform_sdk.models.servicing_objectconfiguration_dependent_dto import ServicingObjectconfigurationDependentDTO +from visier_platform_sdk.models.servicing_objectconfiguration_dimension_change_definition_dto import ServicingObjectconfigurationDimensionChangeDefinitionDTO +from visier_platform_sdk.models.servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto import ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO +from visier_platform_sdk.models.servicing_objectconfiguration_dimensions_change_definitions_dto import ServicingObjectconfigurationDimensionsChangeDefinitionsDTO +from visier_platform_sdk.models.servicing_objectconfiguration_object_change_failure_dto import ServicingObjectconfigurationObjectChangeFailureDTO +from visier_platform_sdk.models.servicing_objectconfiguration_object_change_success_dto import ServicingObjectconfigurationObjectChangeSuccessDTO +from visier_platform_sdk.models.servicing_objectconfiguration_objects_bulk_change_response_dto import ServicingObjectconfigurationObjectsBulkChangeResponseDTO +from visier_platform_sdk.models.servicing_objectconfiguration_properties_change_definitions_dto import ServicingObjectconfigurationPropertiesChangeDefinitionsDTO +from visier_platform_sdk.models.servicing_objectconfiguration_properties_delete_definitions_dto import ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_bulk_delete_response_dto import ServicingObjectconfigurationPropertyBulkDeleteResponseDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_change_definition_dto import ServicingObjectconfigurationPropertyChangeDefinitionDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_change_definitions_by_tenant_dto import ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_definitions_by_tenant_dto import ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_failure_dto import ServicingObjectconfigurationPropertyDeleteFailureDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_success_dto import ServicingObjectconfigurationPropertyDeleteSuccessDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_type_dto import ServicingObjectconfigurationPropertyTypeDTO +from visier_platform_sdk.models.servicing_objectconfiguration_simple_property_type_dto import ServicingObjectconfigurationSimplePropertyTypeDTO +from visier_platform_sdk.models.servicing_objectconfiguration_tags_dto import ServicingObjectconfigurationTagsDTO +from visier_platform_sdk.models.servicing_permission_assigned_by_tenant_dto import ServicingPermissionAssignedByTenantDTO +from visier_platform_sdk.models.servicing_permission_assigned_for_local_tenant_dto import ServicingPermissionAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_permission_assigned_user_dto import ServicingPermissionAssignedUserDTO +from visier_platform_sdk.models.servicing_permission_assigned_users_dto import ServicingPermissionAssignedUsersDTO +from visier_platform_sdk.models.servicing_permission_bulk_operation_response_dto import ServicingPermissionBulkOperationResponseDTO +from visier_platform_sdk.models.servicing_permission_dto import ServicingPermissionDTO +from visier_platform_sdk.models.servicing_permission_error_dto import ServicingPermissionErrorDTO +from visier_platform_sdk.models.servicing_permission_failure_dto import ServicingPermissionFailureDTO +from visier_platform_sdk.models.servicing_permission_success_dto import ServicingPermissionSuccessDTO +from visier_platform_sdk.models.servicing_production_version_api_operation_request_dto import ServicingProductionVersionAPIOperationRequestDTO +from visier_platform_sdk.models.servicing_production_version_api_operation_response_dto import ServicingProductionVersionAPIOperationResponseDTO +from visier_platform_sdk.models.servicing_production_versions_api_operation_request_dto import ServicingProductionVersionsAPIOperationRequestDTO +from visier_platform_sdk.models.servicing_production_versions_api_operation_response_dto import ServicingProductionVersionsAPIOperationResponseDTO +from visier_platform_sdk.models.servicing_profile_assigned_for_accessible_tenant_dto import ServicingProfileAssignedForAccessibleTenantDTO +from visier_platform_sdk.models.servicing_profile_assigned_for_local_tenant_dto import ServicingProfileAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_profile_get_api_response_dto import ServicingProfileGetAPIResponseDTO +from visier_platform_sdk.models.servicing_profiles_get_api_response_dto import ServicingProfilesGetAPIResponseDTO +from visier_platform_sdk.models.servicing_project_commits_api_response_dto import ServicingProjectCommitsAPIResponseDTO +from visier_platform_sdk.models.servicing_project_dto import ServicingProjectDTO +from visier_platform_sdk.models.servicing_project_operation_request_dto import ServicingProjectOperationRequestDTO +from visier_platform_sdk.models.servicing_project_operation_response_dto import ServicingProjectOperationResponseDTO +from visier_platform_sdk.models.servicing_property_access_config_dto import ServicingPropertyAccessConfigDTO +from visier_platform_sdk.models.servicing_property_set_config_dto import ServicingPropertySetConfigDTO +from visier_platform_sdk.models.servicing_question_categories_api_response_dto import ServicingQuestionCategoriesAPIResponseDTO +from visier_platform_sdk.models.servicing_question_category_api_response_dto import ServicingQuestionCategoryAPIResponseDTO +from visier_platform_sdk.models.servicing_reduced_error_dto import ServicingReducedErrorDTO +from visier_platform_sdk.models.servicing_reduced_tenant_code_error_dto import ServicingReducedTenantCodeErrorDTO +from visier_platform_sdk.models.servicing_reduced_user_id_error_dto import ServicingReducedUserIdErrorDTO +from visier_platform_sdk.models.servicing_related_analytic_object_dto import ServicingRelatedAnalyticObjectDTO +from visier_platform_sdk.models.servicing_role_modules_config_dto import ServicingRoleModulesConfigDTO +from visier_platform_sdk.models.servicing_sample_question_api_response_dto import ServicingSampleQuestionAPIResponseDTO +from visier_platform_sdk.models.servicing_sample_questions_api_response_dto import ServicingSampleQuestionsAPIResponseDTO +from visier_platform_sdk.models.servicing_securable_dimension_dto import ServicingSecurableDimensionDTO +from visier_platform_sdk.models.servicing_securable_property_dto import ServicingSecurablePropertyDTO +from visier_platform_sdk.models.servicing_servicing_capability_proto_enum_access_lookup_dto import ServicingServicingCapabilityProtoEnumAccessLookupDTO +from visier_platform_sdk.models.servicing_shareable_data_access_set import ServicingShareableDataAccessSet +from visier_platform_sdk.models.servicing_simple_document_header_search_response_dto import ServicingSimpleDocumentHeaderSearchResponseDTO +from visier_platform_sdk.models.servicing_simple_document_header_search_result_dto import ServicingSimpleDocumentHeaderSearchResultDTO +from visier_platform_sdk.models.servicing_sources_api_operation_request_dto import ServicingSourcesAPIOperationRequestDTO +from visier_platform_sdk.models.servicing_static_dimension_filter_dto import ServicingStaticDimensionFilterDTO +from visier_platform_sdk.models.servicing_successful_accessible_tenant_profile_assignment_dto import ServicingSuccessfulAccessibleTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_successful_local_tenant_profile_assignment_dto import ServicingSuccessfulLocalTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_target_tenant_code_dto import ServicingTargetTenantCodeDTO +from visier_platform_sdk.models.servicing_tenant_code_error_dto import ServicingTenantCodeErrorDTO +from visier_platform_sdk.models.servicing_tenant_data_upload_status_response_dto import ServicingTenantDataUploadStatusResponseDTO +from visier_platform_sdk.models.servicing_tenant_data_upload_update_status_response_dto import ServicingTenantDataUploadUpdateStatusResponseDTO +from visier_platform_sdk.models.servicing_tenant_data_uploads_list_response_dto import ServicingTenantDataUploadsListResponseDTO +from visier_platform_sdk.models.servicing_tenant_data_uploads_response_dto import ServicingTenantDataUploadsResponseDTO +from visier_platform_sdk.models.servicing_tenant_data_uploads_update_response_dto import ServicingTenantDataUploadsUpdateResponseDTO +from visier_platform_sdk.models.servicing_user_creation_api_request_dto import ServicingUserCreationAPIRequestDTO +from visier_platform_sdk.models.servicing_user_get_api_response_dto import ServicingUserGetAPIResponseDTO +from visier_platform_sdk.models.servicing_user_group_assigned_for_local_tenant_dto import ServicingUserGroupAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_user_group_assignment_dto import ServicingUserGroupAssignmentDTO +from visier_platform_sdk.models.servicing_user_id_error_dto import ServicingUserIdErrorDTO +from visier_platform_sdk.models.servicing_user_property_dto import ServicingUserPropertyDTO +from visier_platform_sdk.models.servicing_user_update_api_request_dto import ServicingUserUpdateAPIRequestDTO +from visier_platform_sdk.models.servicing_users_api_error_message_dto import ServicingUsersAPIErrorMessageDTO +from visier_platform_sdk.models.servicing_users_api_failure_dto import ServicingUsersAPIFailureDTO +from visier_platform_sdk.models.servicing_users_api_response_dto import ServicingUsersAPIResponseDTO +from visier_platform_sdk.models.servicing_users_api_success_dto import ServicingUsersAPISuccessDTO +from visier_platform_sdk.models.servicing_users_creation_api_request_dto import ServicingUsersCreationAPIRequestDTO +from visier_platform_sdk.models.servicing_users_delete_api_request_dto import ServicingUsersDeleteAPIRequestDTO +from visier_platform_sdk.models.servicing_users_update_api_request_dto import ServicingUsersUpdateAPIRequestDTO +from visier_platform_sdk.models.servicing_users_update_api_user_dto import ServicingUsersUpdateAPIUserDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_definition_dto import ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_request_dto import ServicingV2ObjectconfigurationAnalyticObjectRequestDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_with_context_dto import ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_basic_information_dto import ServicingV2ObjectconfigurationBasicInformationDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_bulk_change_response_dto import ServicingV2ObjectconfigurationBulkChangeResponseDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_calculated_property_type_dto import ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_definition_dto import ServicingV2ObjectconfigurationConceptDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_delete_request_dto import ServicingV2ObjectconfigurationConceptDeleteRequestDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_delete_with_context_dto import ServicingV2ObjectconfigurationConceptDeleteWithContextDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_request_dto import ServicingV2ObjectconfigurationConceptRequestDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_response_dto import ServicingV2ObjectconfigurationConceptResponseDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_type_details_dto import ServicingV2ObjectconfigurationConceptTypeDetailsDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_with_context_dto import ServicingV2ObjectconfigurationConceptWithContextDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_execution_context_dto import ServicingV2ObjectconfigurationExecutionContextDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_failed_change_dto import ServicingV2ObjectconfigurationFailedChangeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_metric_definition_dto import ServicingV2ObjectconfigurationMetricDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_metric_type_details_dto import ServicingV2ObjectconfigurationMetricTypeDetailsDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_object_id_dto import ServicingV2ObjectconfigurationObjectIdDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_definition_dto import ServicingV2ObjectconfigurationProcessConceptDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_member_dto import ServicingV2ObjectconfigurationProcessConceptMemberDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_member_list_dto import ServicingV2ObjectconfigurationProcessConceptMemberListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_metric_definition_dto import ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_metric_list_dto import ServicingV2ObjectconfigurationProcessConceptMetricListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_outcome_dto import ServicingV2ObjectconfigurationProcessConceptOutcomeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_outcome_list_dto import ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_property_list_dto import ServicingV2ObjectconfigurationProcessConceptPropertyListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_property_type_dto import ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_stage_dto import ServicingV2ObjectconfigurationProcessConceptStageDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_stage_list_dto import ServicingV2ObjectconfigurationProcessConceptStageListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_property_definition_dto import ServicingV2ObjectconfigurationPropertyDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_property_type_details_dto import ServicingV2ObjectconfigurationPropertyTypeDetailsDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_simple_property_type_dto import ServicingV2ObjectconfigurationSimplePropertyTypeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_successful_change_dto import ServicingV2ObjectconfigurationSuccessfulChangeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_synonym_list_dto import ServicingV2ObjectconfigurationSynonymListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_tag_reference_dto import ServicingV2ObjectconfigurationTagReferenceDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_tag_reference_list_dto import ServicingV2ObjectconfigurationTagReferenceListDTO +from visier_platform_sdk.models.servicing_vee_question_change_definition_dto import ServicingVeeQuestionChangeDefinitionDTO +from visier_platform_sdk.models.servicing_vee_question_change_definitions_by_tenant_dto import ServicingVeeQuestionChangeDefinitionsByTenantDTO +from visier_platform_sdk.models.servicing_vee_question_change_failure_dto import ServicingVeeQuestionChangeFailureDTO +from visier_platform_sdk.models.servicing_vee_question_change_success_dto import ServicingVeeQuestionChangeSuccessDTO +from visier_platform_sdk.models.servicing_vee_question_delete_definitions_by_tenant_dto import ServicingVeeQuestionDeleteDefinitionsByTenantDTO +from visier_platform_sdk.models.servicing_vee_questions_bulk_change_response_dto import ServicingVeeQuestionsBulkChangeResponseDTO +from visier_platform_sdk.models.servicing_vee_questions_change_definitions_dto import ServicingVeeQuestionsChangeDefinitionsDTO +from visier_platform_sdk.models.servicing_vee_questions_delete_definitions_dto import ServicingVeeQuestionsDeleteDefinitionsDTO +from visier_platform_sdk.models.skill import Skill +from visier_platform_sdk.models.skill_category import SkillCategory +from visier_platform_sdk.models.skill_category_entry import SkillCategoryEntry +from visier_platform_sdk.models.skill_entry import SkillEntry +from visier_platform_sdk.models.skill_extraction_input import SkillExtractionInput +from visier_platform_sdk.models.skill_group import SkillGroup +from visier_platform_sdk.models.skill_group_entry import SkillGroupEntry +from visier_platform_sdk.models.skill_match_input import SkillMatchInput +from visier_platform_sdk.models.source_import_result_summary_dto import SourceImportResultSummaryDTO +from visier_platform_sdk.models.sources_api_put_response_dto import SourcesAPIPutResponseDTO +from visier_platform_sdk.models.sql_like200_response import SqlLike200Response +from visier_platform_sdk.models.status import Status +from visier_platform_sdk.models.systemstatus_system_status_dto import SystemstatusSystemStatusDTO +from visier_platform_sdk.models.systemstatus_vee_status_dto import SystemstatusVeeStatusDTO +from visier_platform_sdk.models.table_response_dto import TableResponseDTO +from visier_platform_sdk.models.token_response import TokenResponse +from visier_platform_sdk.models.user_creation_api_response_dto import UserCreationAPIResponseDTO diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_all_tenants_status_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_all_tenants_status_apidto.py new file mode 100644 index 0000000000..0b4d5e6724 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_all_tenants_status_apidto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_tenant_detail_apidto import AdminTenantDetailAPIDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminAllTenantsStatusAPIDTO(BaseModel): + """ + AdminAllTenantsStatusAPIDTO + """ # noqa: E501 + tenants: Optional[List[AdminTenantDetailAPIDTO]] = Field(default=None, description="A list of objects representing all the analytic tenants.") + limit: Optional[StrictInt] = Field(default=None, description="The limit of analytic tenants to return. The maximum value is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving values from, also known as offset. The index begins at 0.") + __properties: ClassVar[List[str]] = ["tenants", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminAllTenantsStatusAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminAllTenantsStatusAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [AdminTenantDetailAPIDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_assign_connector_credentials_by_tenant_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_assign_connector_credentials_by_tenant_response_dto.py new file mode 100644 index 0000000000..f002269793 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_assign_connector_credentials_by_tenant_response_dto.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_assign_connector_with_credentials_response_dto import AdminAssignConnectorWithCredentialsResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminAssignConnectorCredentialsByTenantResponseDTO(BaseModel): + """ + AdminAssignConnectorCredentialsByTenantResponseDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the tenant.", alias="tenantCode") + connectors: Optional[List[AdminAssignConnectorWithCredentialsResponseDTO]] = Field(default=None, description="A list of objects representing the assigned credentials and connectors.") + status: Optional[StrictStr] = Field(default=None, description="The state of the credential assignment. Valid values are Succeed or Failed.") + message: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["tenantCode", "connectors", "status", "message"] + + @field_validator('status') + def status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unknown', 'Succeed', 'Failed']): + raise ValueError("must be one of enum values ('Unknown', 'Succeed', 'Failed')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminAssignConnectorCredentialsByTenantResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connectors (list) + _items = [] + if self.connectors: + for _item_connectors in self.connectors: + if _item_connectors: + _items.append(_item_connectors.to_dict()) + _dict['connectors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminAssignConnectorCredentialsByTenantResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "connectors": [AdminAssignConnectorWithCredentialsResponseDTO.from_dict(_item) for _item in obj["connectors"]] if obj.get("connectors") is not None else None, + "status": obj.get("status"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_assign_connector_credentials_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_assign_connector_credentials_response_dto.py new file mode 100644 index 0000000000..caa4dd7e3e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_assign_connector_credentials_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_assign_connector_credentials_by_tenant_response_dto import AdminAssignConnectorCredentialsByTenantResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminAssignConnectorCredentialsResponseDTO(BaseModel): + """ + AdminAssignConnectorCredentialsResponseDTO + """ # noqa: E501 + tenants: Optional[List[AdminAssignConnectorCredentialsByTenantResponseDTO]] = Field(default=None, description="A list of objects representing the tenants and data connectors that were assigned connector credentials.") + __properties: ClassVar[List[str]] = ["tenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminAssignConnectorCredentialsResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminAssignConnectorCredentialsResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [AdminAssignConnectorCredentialsByTenantResponseDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_assign_connector_with_credentials_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_assign_connector_with_credentials_response_dto.py new file mode 100644 index 0000000000..5bee67308c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_assign_connector_with_credentials_response_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_assigned_credential_info_response_dto import AdminAssignedCredentialInfoResponseDTO +from visier_platform_sdk.models.admin_connector_info_response_dto import AdminConnectorInfoResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminAssignConnectorWithCredentialsResponseDTO(BaseModel): + """ + AdminAssignConnectorWithCredentialsResponseDTO + """ # noqa: E501 + connector: Optional[AdminConnectorInfoResponseDTO] = Field(default=None, description="The data connector that was assigned a connector credential.") + credential: Optional[AdminAssignedCredentialInfoResponseDTO] = Field(default=None, description="A connector credential that was assigned to a data connector") + __properties: ClassVar[List[str]] = ["connector", "credential"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminAssignConnectorWithCredentialsResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of connector + if self.connector: + _dict['connector'] = self.connector.to_dict() + # override the default output from pydantic by calling `to_dict()` of credential + if self.credential: + _dict['credential'] = self.credential.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminAssignConnectorWithCredentialsResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connector": AdminConnectorInfoResponseDTO.from_dict(obj["connector"]) if obj.get("connector") is not None else None, + "credential": AdminAssignedCredentialInfoResponseDTO.from_dict(obj["credential"]) if obj.get("credential") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_assigned_credential_info_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_assigned_credential_info_response_dto.py new file mode 100644 index 0000000000..b6733de099 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_assigned_credential_info_response_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminAssignedCredentialInfoResponseDTO(BaseModel): + """ + AdminAssignedCredentialInfoResponseDTO + """ # noqa: E501 + credential_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user.", alias="credentialId") + display_name: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@visier.com.", alias="displayName") + message: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["credentialId", "displayName", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminAssignedCredentialInfoResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminAssignedCredentialInfoResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "credentialId": obj.get("credentialId"), + "displayName": obj.get("displayName"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_batch_tenant_provision_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_batch_tenant_provision_apidto.py new file mode 100644 index 0000000000..33a731c2de --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_batch_tenant_provision_apidto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_tenant_provision_apidto import AdminTenantProvisionAPIDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminBatchTenantProvisionAPIDTO(BaseModel): + """ + AdminBatchTenantProvisionAPIDTO + """ # noqa: E501 + tenants: Optional[List[AdminTenantProvisionAPIDTO]] = Field(default=None, description="An array of tenants to create. The maximum number of tenants to create in one request is 200.") + __properties: ClassVar[List[str]] = ["tenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminBatchTenantProvisionAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminBatchTenantProvisionAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [AdminTenantProvisionAPIDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_business_location_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_business_location_dto.py new file mode 100644 index 0000000000..edfe34aa8b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_business_location_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminBusinessLocationDTO(BaseModel): + """ + The location of operations or where business is performed. + """ # noqa: E501 + country_code: Optional[StrictStr] = Field(default=None, description="The country in which the business is located or business is performed. The country code must follow ISO 3166 standards in alpha-2 format (two-letter code).", alias="countryCode") + postal_code: Optional[StrictStr] = Field(default=None, description="The postal code associated with the business location. Cannot be blank.", alias="postalCode") + __properties: ClassVar[List[str]] = ["countryCode", "postalCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminBusinessLocationDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminBusinessLocationDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "countryCode": obj.get("countryCode"), + "postalCode": obj.get("postalCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_info_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_info_response_dto.py new file mode 100644 index 0000000000..02151e0362 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_info_response_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminConnectorInfoResponseDTO(BaseModel): + """ + AdminConnectorInfoResponseDTO + """ # noqa: E501 + connector_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the data connector.", alias="connectorId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable data connector name that is displayed within Visier.", alias="displayName") + description: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["connectorId", "displayName", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminConnectorInfoResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminConnectorInfoResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connectorId": obj.get("connectorId"), + "displayName": obj.get("displayName"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_setting_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_setting_request_dto.py new file mode 100644 index 0000000000..e3acd01008 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_setting_request_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminConnectorSettingRequestDTO(BaseModel): + """ + AdminConnectorSettingRequestDTO + """ # noqa: E501 + setting_key: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the setting.", alias="settingKey") + value: Optional[StrictStr] = Field(default=None, description="The setting's value.") + __properties: ClassVar[List[str]] = ["settingKey", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminConnectorSettingRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminConnectorSettingRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "settingKey": obj.get("settingKey"), + "value": obj.get("value") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_setting_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_setting_response_dto.py new file mode 100644 index 0000000000..36842252e2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_setting_response_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminConnectorSettingResponseDTO(BaseModel): + """ + AdminConnectorSettingResponseDTO + """ # noqa: E501 + key: Optional[StrictStr] = Field(default=None, description="The unique identifier of the connector setting.") + value: Optional[StrictStr] = Field(default=None, description="The value that was set for the connector setting.") + message: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["key", "value", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminConnectorSettingResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminConnectorSettingResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "value": obj.get("value"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_settings_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_settings_response_dto.py new file mode 100644 index 0000000000..5e06ff198f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_connector_settings_response_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_connector_info_response_dto import AdminConnectorInfoResponseDTO +from visier_platform_sdk.models.admin_connector_setting_response_dto import AdminConnectorSettingResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminConnectorSettingsResponseDTO(BaseModel): + """ + AdminConnectorSettingsResponseDTO + """ # noqa: E501 + connector: Optional[AdminConnectorInfoResponseDTO] = Field(default=None, description="The data connector that was updated in the API request.") + settings: Optional[List[AdminConnectorSettingResponseDTO]] = Field(default=None, description="The settings that were updated for a data connector.") + __properties: ClassVar[List[str]] = ["connector", "settings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminConnectorSettingsResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of connector + if self.connector: + _dict['connector'] = self.connector.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in settings (list) + _items = [] + if self.settings: + for _item_settings in self.settings: + if _item_settings: + _items.append(_item_settings.to_dict()) + _dict['settings'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminConnectorSettingsResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connector": AdminConnectorInfoResponseDTO.from_dict(obj["connector"]) if obj.get("connector") is not None else None, + "settings": [AdminConnectorSettingResponseDTO.from_dict(_item) for _item in obj["settings"]] if obj.get("settings") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_excluded_source_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_excluded_source_list_dto.py new file mode 100644 index 0000000000..dbdf1677e5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_excluded_source_list_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminConsolidatedAnalyticsAPIExcludedSourceListDTO(BaseModel): + """ + AdminConsolidatedAnalyticsAPIExcludedSourceListDTO + """ # noqa: E501 + excluded_sources: Optional[List[StrictStr]] = Field(default=None, description="A list of the CA tenant's excluded sources.", alias="excludedSources") + __properties: ClassVar[List[str]] = ["excludedSources"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPIExcludedSourceListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPIExcludedSourceListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "excludedSources": obj.get("excludedSources") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_source_tenant_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_source_tenant_list_dto.py new file mode 100644 index 0000000000..e804db347b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_source_tenant_list_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminConsolidatedAnalyticsAPISourceTenantListDTO(BaseModel): + """ + AdminConsolidatedAnalyticsAPISourceTenantListDTO + """ # noqa: E501 + tenant_codes: Optional[List[StrictStr]] = Field(default=None, description="A list of the CA tenant's source tenants.", alias="tenantCodes") + __properties: ClassVar[List[str]] = ["tenantCodes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPISourceTenantListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPISourceTenantListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCodes": obj.get("tenantCodes") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_create_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_create_request_dto.py new file mode 100644 index 0000000000..56366ac102 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_create_request_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminConsolidatedAnalyticsAPITenantCreateRequestDTO(BaseModel): + """ + AdminConsolidatedAnalyticsAPITenantCreateRequestDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.", alias="tenantCode") + __properties: ClassVar[List[str]] = ["tenantCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPITenantCreateRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPITenantCreateRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_list_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_list_response_dto.py new file mode 100644 index 0000000000..c1d24cd91a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_list_response_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminConsolidatedAnalyticsAPITenantListResponseDTO(BaseModel): + """ + AdminConsolidatedAnalyticsAPITenantListResponseDTO + """ # noqa: E501 + tenant_codes: Optional[List[StrictStr]] = Field(default=None, description="A list of CA tenant codes.", alias="tenantCodes") + __properties: ClassVar[List[str]] = ["tenantCodes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPITenantListResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPITenantListResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCodes": obj.get("tenantCodes") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details.py new file mode 100644 index 0000000000..ed36615e0a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminConsolidatedAnalyticsAPITenantWithDetails(BaseModel): + """ + AdminConsolidatedAnalyticsAPITenantWithDetails + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The CA tenant's code.", alias="tenantCode") + source_tenants_list: Optional[List[StrictStr]] = Field(default=None, description="A list of the CA tenant's source tenants.", alias="sourceTenantsList") + excluded_sources_list: Optional[List[StrictStr]] = Field(default=None, description="A list of the CA tenant's excluded sources.", alias="excludedSourcesList") + __properties: ClassVar[List[str]] = ["tenantCode", "sourceTenantsList", "excludedSourcesList"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPITenantWithDetails from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPITenantWithDetails from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "sourceTenantsList": obj.get("sourceTenantsList"), + "excludedSourcesList": obj.get("excludedSourcesList") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details_list_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details_list_response_dto.py new file mode 100644 index 0000000000..84004c795e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details_list_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_consolidated_analytics_api_tenant_with_details import AdminConsolidatedAnalyticsAPITenantWithDetails +from typing import Optional, Set +from typing_extensions import Self + +class AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO(BaseModel): + """ + AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO + """ # noqa: E501 + tenants: Optional[List[AdminConsolidatedAnalyticsAPITenantWithDetails]] = Field(default=None, description="A list of CA tenants and their details.") + __properties: ClassVar[List[str]] = ["tenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [AdminConsolidatedAnalyticsAPITenantWithDetails.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_custom_property_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_custom_property_dto.py new file mode 100644 index 0000000000..6df08a0c38 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_custom_property_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminCustomPropertyDTO(BaseModel): + """ + AdminCustomPropertyDTO + """ # noqa: E501 + key: Optional[StrictStr] = None + value: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["key", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminCustomPropertyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminCustomPropertyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "value": obj.get("value") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_custom_tenant_property_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_custom_tenant_property_dto.py new file mode 100644 index 0000000000..3ff17ec9ca --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_custom_tenant_property_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminCustomTenantPropertyDTO(BaseModel): + """ + AdminCustomTenantPropertyDTO + """ # noqa: E501 + key: Optional[StrictStr] = None + value: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["key", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminCustomTenantPropertyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminCustomTenantPropertyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "value": obj.get("value") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_data_import_definition_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_data_import_definition_apidto.py new file mode 100644 index 0000000000..75401e5c90 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_data_import_definition_apidto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminDataImportDefinitionAPIDTO(BaseModel): + """ + AdminDataImportDefinitionAPIDTO + """ # noqa: E501 + connector_id: Optional[StrictStr] = Field(default=None, description="The ID associated with the data connector.", alias="connectorId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable data connector name that is displayed within Visier.", alias="displayName") + credential_id: Optional[StrictStr] = Field(default=None, description="The ID associated with the connector credentials currently assigned to this data connector.", alias="credentialId") + __properties: ClassVar[List[str]] = ["connectorId", "displayName", "credentialId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminDataImportDefinitionAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminDataImportDefinitionAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connectorId": obj.get("connectorId"), + "displayName": obj.get("displayName"), + "credentialId": obj.get("credentialId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_data_import_definitions_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_data_import_definitions_apidto.py new file mode 100644 index 0000000000..8ff55e8233 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_data_import_definitions_apidto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_data_import_definition_apidto import AdminDataImportDefinitionAPIDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminDataImportDefinitionsAPIDTO(BaseModel): + """ + AdminDataImportDefinitionsAPIDTO + """ # noqa: E501 + data_connectors: Optional[List[AdminDataImportDefinitionAPIDTO]] = Field(default=None, description="A list of objects representing all the available data connectors in Production.", alias="dataConnectors") + limit: Optional[StrictInt] = Field(default=None, description="The number of data connectors to return. The maximum number of data connectors to return is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving values from, also known as offset. The index begins at 0.") + __properties: ClassVar[List[str]] = ["dataConnectors", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminDataImportDefinitionsAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_connectors (list) + _items = [] + if self.data_connectors: + for _item_data_connectors in self.data_connectors: + if _item_data_connectors: + _items.append(_item_data_connectors.to_dict()) + _dict['dataConnectors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminDataImportDefinitionsAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataConnectors": [AdminDataImportDefinitionAPIDTO.from_dict(_item) for _item in obj["dataConnectors"]] if obj.get("dataConnectors") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_data_version_and_date_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_data_version_and_date_dto.py new file mode 100644 index 0000000000..fbe75e2dea --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_data_version_and_date_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminDataVersionAndDateDTO(BaseModel): + """ + AdminDataVersionAndDateDTO + """ # noqa: E501 + data_version: Optional[StrictStr] = Field(default=None, description="The data version ID.", alias="dataVersion") + data_version_date: Optional[StrictStr] = Field(default=None, description="The date that the data version was created.", alias="dataVersionDate") + __properties: ClassVar[List[str]] = ["dataVersion", "dataVersionDate"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminDataVersionAndDateDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminDataVersionAndDateDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataVersion": obj.get("dataVersion"), + "dataVersionDate": obj.get("dataVersionDate") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_delete_user_group_v2_request.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_delete_user_group_v2_request.py new file mode 100644 index 0000000000..622d9ff309 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_delete_user_group_v2_request.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminDeleteUserGroupV2Request(BaseModel): + """ + AdminDeleteUserGroupV2Request + """ # noqa: E501 + user_group_id: Optional[StrictStr] = Field(default=None, description="The ID of user group to delete.", alias="userGroupId") + __properties: ClassVar[List[str]] = ["userGroupId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminDeleteUserGroupV2Request from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminDeleteUserGroupV2Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroupId": obj.get("userGroupId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_element_ids_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_element_ids_dto.py new file mode 100644 index 0000000000..a1c97ce346 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_element_ids_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminElementIDsDTO(BaseModel): + """ + AdminElementIDsDTO + """ # noqa: E501 + ids: Optional[List[StrictStr]] = Field(default=None, description="The unique identifiers.") + __properties: ClassVar[List[str]] = ["ids"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminElementIDsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminElementIDsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "ids": obj.get("ids") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_email_domains_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_email_domains_dto.py new file mode 100644 index 0000000000..2ba78469ba --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_email_domains_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminEmailDomainsDTO(BaseModel): + """ + AdminEmailDomainsDTO + """ # noqa: E501 + domains: Optional[List[StrictStr]] = Field(default=None, description="The list of allowed email address domains.") + confirm_not_allowed_domain: Optional[StrictBool] = Field(default=None, description="If `true`, you cannot sign in using credentials, such as username and password. You can only log in with single sign-on (SSO). To avoid this, add your current email address's domain to allowed domains list.", alias="confirmNotAllowedDomain") + __properties: ClassVar[List[str]] = ["domains", "confirmNotAllowedDomain"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminEmailDomainsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminEmailDomainsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "domains": obj.get("domains"), + "confirmNotAllowedDomain": obj.get("confirmNotAllowedDomain") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_excluded_sources_body.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_excluded_sources_body.py new file mode 100644 index 0000000000..2d4dafb11a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_excluded_sources_body.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminExcludedSourcesBody(BaseModel): + """ + AdminExcludedSourcesBody + """ # noqa: E501 + excluded_sources: Optional[List[StrictStr]] = Field(default=None, description="A list of a CA tenant's excluded sources.", alias="excludedSources") + __properties: ClassVar[List[str]] = ["excludedSources"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminExcludedSourcesBody from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminExcludedSourcesBody from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "excludedSources": obj.get("excludedSources") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_extractor_setting_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_extractor_setting_apidto.py new file mode 100644 index 0000000000..66285f1177 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_extractor_setting_apidto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_extractor_setting_key_value_apidto import AdminExtractorSettingKeyValueAPIDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminExtractorSettingAPIDTO(BaseModel): + """ + AdminExtractorSettingAPIDTO + """ # noqa: E501 + connector_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the data connector.", alias="connectorId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable data connector name that is displayed within Visier.", alias="displayName") + connector_settings: Optional[List[AdminExtractorSettingKeyValueAPIDTO]] = Field(default=None, description="A list of objects representing the settings that are available for the data connector.", alias="connectorSettings") + __properties: ClassVar[List[str]] = ["connectorId", "displayName", "connectorSettings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminExtractorSettingAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connector_settings (list) + _items = [] + if self.connector_settings: + for _item_connector_settings in self.connector_settings: + if _item_connector_settings: + _items.append(_item_connector_settings.to_dict()) + _dict['connectorSettings'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminExtractorSettingAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connectorId": obj.get("connectorId"), + "displayName": obj.get("displayName"), + "connectorSettings": [AdminExtractorSettingKeyValueAPIDTO.from_dict(_item) for _item in obj["connectorSettings"]] if obj.get("connectorSettings") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_extractor_setting_key_value_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_extractor_setting_key_value_apidto.py new file mode 100644 index 0000000000..1bff2be188 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_extractor_setting_key_value_apidto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminExtractorSettingKeyValueAPIDTO(BaseModel): + """ + AdminExtractorSettingKeyValueAPIDTO + """ # noqa: E501 + setting_key: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the setting.", alias="settingKey") + value: Optional[StrictStr] = Field(default=None, description="The current value of the setting.") + __properties: ClassVar[List[str]] = ["settingKey", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminExtractorSettingKeyValueAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminExtractorSettingKeyValueAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "settingKey": obj.get("settingKey"), + "value": obj.get("value") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_extractor_settings_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_extractor_settings_apidto.py new file mode 100644 index 0000000000..a26f5121d4 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_extractor_settings_apidto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_extractor_setting_apidto import AdminExtractorSettingAPIDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminExtractorSettingsAPIDTO(BaseModel): + """ + AdminExtractorSettingsAPIDTO + """ # noqa: E501 + connectors: Optional[List[AdminExtractorSettingAPIDTO]] = Field(default=None, description="A list of all data connectors in the production environment and their settings.") + __properties: ClassVar[List[str]] = ["connectors"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminExtractorSettingsAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connectors (list) + _items = [] + if self.connectors: + for _item_connectors in self.connectors: + if _item_connectors: + _items.append(_item_connectors.to_dict()) + _dict['connectors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminExtractorSettingsAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connectors": [AdminExtractorSettingAPIDTO.from_dict(_item) for _item in obj["connectors"]] if obj.get("connectors") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_home_analysis_by_user_group_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_home_analysis_by_user_group_dto.py new file mode 100644 index 0000000000..f235517b40 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_home_analysis_by_user_group_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminHomeAnalysisByUserGroupDTO(BaseModel): + """ + AdminHomeAnalysisByUserGroupDTO + """ # noqa: E501 + user_group_id: Optional[StrictStr] = Field(default=None, description="The user group ID.", alias="userGroupId") + home_analysis_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analysis to show for this user group when a user logs in.", alias="homeAnalysisId") + __properties: ClassVar[List[str]] = ["userGroupId", "homeAnalysisId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminHomeAnalysisByUserGroupDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminHomeAnalysisByUserGroupDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroupId": obj.get("userGroupId"), + "homeAnalysisId": obj.get("homeAnalysisId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_jobs_consolidated_analytics_job_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_jobs_consolidated_analytics_job_request_dto.py new file mode 100644 index 0000000000..a7a1a97018 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_jobs_consolidated_analytics_job_request_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminJobsConsolidatedAnalyticsJobRequestDTO(BaseModel): + """ + AdminJobsConsolidatedAnalyticsJobRequestDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the consolidated analytics tenant; for example, \"WFF_j1r~CAa7s\".", alias="tenantCode") + __properties: ClassVar[List[str]] = ["tenantCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminJobsConsolidatedAnalyticsJobRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminJobsConsolidatedAnalyticsJobRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_jobs_extract_data_and_load_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_jobs_extract_data_and_load_dto.py new file mode 100644 index 0000000000..dd6645d899 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_jobs_extract_data_and_load_dto.py @@ -0,0 +1,150 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminJobsExtractDataAndLoadDTO(BaseModel): + """ + AdminJobsExtractDataAndLoadDTO + """ # noqa: E501 + tenants: Optional[List[StrictStr]] = Field(default=None, description="A list of analytic tenants to dispatch extraction jobs for. One extraction job is dispatched per tenant. Only valid for requests from an administrating tenant.") + all_tenants: Optional[StrictBool] = Field(default=None, description="If `true`, one extraction job is dispatched for each accessible analytic tenant. Only valid for requests from an administrating tenant.", alias="allTenants") + override_last_extraction_timestamp: Optional[StrictStr] = Field(default=None, description="An epoch timestamp in milliseconds from which to retrieve data. This overrides the last extraction date to retrieve more data.", alias="overrideLastExtractionTimestamp") + publish_data_load_artifacts: Optional[StrictBool] = Field(default=None, description="If `true`, the generated data load artifacts are published to production immediately.", alias="publishDataLoadArtifacts") + run_processing_job: Optional[StrictBool] = Field(default=None, description="If `true`, a processing job is spawned after a dispatched extraction job runs successfully.", alias="runProcessingJob") + data_category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the data category on which to trigger the extraction job. Default is the tenant's primary data category.", alias="dataCategoryId") + disable_artifact_generation: Optional[StrictBool] = Field(default=None, description="If `true`, the job does not generate data load artifacts. If unspecified, the default is `false`.", alias="disableArtifactGeneration") + connector_ids: Optional[List[StrictStr]] = Field(default=None, description="The unique identifiers of the connectors to run extraction jobs.", alias="connectorIds") + last_extraction_time_offset_weeks: Optional[StrictInt] = Field(default=None, description="The number of weeks in the past to retrieve data. This overrides the last extraction date to retrieve more data.", alias="lastExtractionTimeOffsetWeeks") + months_to_extract: Optional[StrictInt] = Field(default=None, description="The number of months to retrieve snapshot data.", alias="monthsToExtract") + extract_to_time_override: Optional[StrictStr] = Field(default=None, description="An epoch timestamp in milliseconds for the end time up to which to retrieve data.", alias="extractToTimeOverride") + batch_size_override: Optional[StrictInt] = Field(default=None, description="The maximum number of subjects the job can retrieve in each batch.", alias="batchSizeOverride") + sql_batch_size: Optional[StrictInt] = Field(default=None, description="The maximum number of SQL table records the job can retrieve in each batch.", alias="sqlBatchSize") + force_update_existing_artifacts: Optional[StrictBool] = Field(default=None, description="If `true` and `disableArtifactGeneration` is `false`, updates extractor artifacts, which may overwrite the artifacts' manual overrides. Ignored if `disableArtifactGeneration` is `true`.", alias="forceUpdateExistingArtifacts") + excluded_tenants: Optional[List[StrictStr]] = Field(default=None, description="The unique identifiers of the tenants to exclude from the extraction job. Only valid if `allTenants` is `true`. Only valid for requests from an administrating tenant.", alias="excludedTenants") + spill_debug_info_partitions_dto: Optional[StrictStr] = Field(default=None, description="The partitioning of debugging info to be generated, if any. Valid values are: - `spillNone`: No debugging info is generated. - `spillStagesAndRecords`: Debugging info is generated for stages and records. - `spillAll`: Debugging info is generated for all partitions.", alias="spillDebugInfoPartitionsDTO") + spill_debug_info_detail_level_dto: Optional[StrictStr] = Field(default=None, description="The detail level of the debugging info to be generated. Valid values are: - `fileAndLine`: Debugging info is generated for file and line. - `mappingName`: Debugging info is generated for mapping name.", alias="spillDebugInfoDetailLevelDTO") + last_extraction_time_offset_months: Optional[StrictInt] = Field(default=None, description="The number of months to offset the last extraction time. This overrides the last extraction date backward to retrieve more data.", alias="lastExtractionTimeOffsetMonths") + last_extraction_time_offset_mode: Optional[StrictStr] = Field(default=None, description="The mode used to offset the last extraction time (weeks vs months)", alias="lastExtractionTimeOffsetMode") + offset_week_option: Optional[StrictStr] = Field(default=None, description="The week options used to offset the last extraction time (first of day / last of day)", alias="offsetWeekOption") + offset_month_option: Optional[StrictStr] = Field(default=None, description="The month options used to offset the last extraction time (first of month / last of month)", alias="offsetMonthOption") + credential_id: Optional[StrictStr] = Field(default=None, description="If running a job for the Databricks connector, specify the unique identifier of the connector credentials to use.", alias="credentialId") + __properties: ClassVar[List[str]] = ["tenants", "allTenants", "overrideLastExtractionTimestamp", "publishDataLoadArtifacts", "runProcessingJob", "dataCategoryId", "disableArtifactGeneration", "connectorIds", "lastExtractionTimeOffsetWeeks", "monthsToExtract", "extractToTimeOverride", "batchSizeOverride", "sqlBatchSize", "forceUpdateExistingArtifacts", "excludedTenants", "spillDebugInfoPartitionsDTO", "spillDebugInfoDetailLevelDTO", "lastExtractionTimeOffsetMonths", "lastExtractionTimeOffsetMode", "offsetWeekOption", "offsetMonthOption", "credentialId"] + + @field_validator('spill_debug_info_partitions_dto') + def spill_debug_info_partitions_dto_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['spillNone', 'spillStagesAndRecords', 'spillAll']): + raise ValueError("must be one of enum values ('spillNone', 'spillStagesAndRecords', 'spillAll')") + return value + + @field_validator('spill_debug_info_detail_level_dto') + def spill_debug_info_detail_level_dto_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['fileAndLine', 'mappingName']): + raise ValueError("must be one of enum values ('fileAndLine', 'mappingName')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminJobsExtractDataAndLoadDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminJobsExtractDataAndLoadDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": obj.get("tenants"), + "allTenants": obj.get("allTenants"), + "overrideLastExtractionTimestamp": obj.get("overrideLastExtractionTimestamp"), + "publishDataLoadArtifacts": obj.get("publishDataLoadArtifacts"), + "runProcessingJob": obj.get("runProcessingJob"), + "dataCategoryId": obj.get("dataCategoryId"), + "disableArtifactGeneration": obj.get("disableArtifactGeneration"), + "connectorIds": obj.get("connectorIds"), + "lastExtractionTimeOffsetWeeks": obj.get("lastExtractionTimeOffsetWeeks"), + "monthsToExtract": obj.get("monthsToExtract"), + "extractToTimeOverride": obj.get("extractToTimeOverride"), + "batchSizeOverride": obj.get("batchSizeOverride"), + "sqlBatchSize": obj.get("sqlBatchSize"), + "forceUpdateExistingArtifacts": obj.get("forceUpdateExistingArtifacts"), + "excludedTenants": obj.get("excludedTenants"), + "spillDebugInfoPartitionsDTO": obj.get("spillDebugInfoPartitionsDTO"), + "spillDebugInfoDetailLevelDTO": obj.get("spillDebugInfoDetailLevelDTO"), + "lastExtractionTimeOffsetMonths": obj.get("lastExtractionTimeOffsetMonths"), + "lastExtractionTimeOffsetMode": obj.get("lastExtractionTimeOffsetMode"), + "offsetWeekOption": obj.get("offsetWeekOption"), + "offsetMonthOption": obj.get("offsetMonthOption"), + "credentialId": obj.get("credentialId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_jobs_processing_job_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_jobs_processing_job_request_dto.py new file mode 100644 index 0000000000..97c4d91d58 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_jobs_processing_job_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminJobsProcessingJobRequestDTO(BaseModel): + """ + AdminJobsProcessingJobRequestDTO + """ # noqa: E501 + tenants: Optional[List[StrictStr]] = Field(default=None, description="The tenant codes of the tenants to run processing jobs for. If omitted, runs a processing job for the tenant associated with the user who made the API request. Only valid for requests from an administrating tenant.") + all_tenants: Optional[StrictBool] = Field(default=None, description="If `true`, runs processing jobs for all accessible analytic tenants. Default is `false`. Only valid for requests from an administrating tenant.", alias="allTenants") + data_category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the data category to run the job. If omitted, runs a job using the primary data category. To retrieve a list of all data categories, see `GET /v1/op/data/categories`.", alias="dataCategoryId") + publish_to_production: Optional[StrictBool] = Field(default=None, description="If `true`, publishes the generated data version to production. Default is `false`.", alias="publishToProduction") + excluded_tenants: Optional[List[StrictStr]] = Field(default=None, description="The unique IDs of the tenants to exclude from the extraction job. Only valid if `allTenants` is \"true\". Only valid for requests from an administrating tenant.", alias="excludedTenants") + __properties: ClassVar[List[str]] = ["tenants", "allTenants", "dataCategoryId", "publishToProduction", "excludedTenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminJobsProcessingJobRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminJobsProcessingJobRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": obj.get("tenants"), + "allTenants": obj.get("allTenants"), + "dataCategoryId": obj.get("dataCategoryId"), + "publishToProduction": obj.get("publishToProduction"), + "excludedTenants": obj.get("excludedTenants") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_key_name.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_key_name.py new file mode 100644 index 0000000000..39d41bae86 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_key_name.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminKeyName(BaseModel): + """ + AdminKeyName + """ # noqa: E501 + key_name: Optional[StrictStr] = Field(default=None, description="The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 3 and 36 characters long.", alias="keyName") + __properties: ClassVar[List[str]] = ["keyName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminKeyName from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminKeyName from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "keyName": obj.get("keyName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_mask_message.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_mask_message.py new file mode 100644 index 0000000000..aedc691f6e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_mask_message.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminMaskMessage(BaseModel): + """ + AdminMaskMessage + """ # noqa: E501 + mask: Optional[StrictStr] = Field(default=None, description="A comma-separated list of strings that specifies which fields to include in the response.") + __properties: ClassVar[List[str]] = ["mask"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminMaskMessage from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminMaskMessage from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "mask": obj.get("mask") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_multiple_tenant_data_versions_details_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_multiple_tenant_data_versions_details_dto.py new file mode 100644 index 0000000000..0e1089024b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_multiple_tenant_data_versions_details_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_data_version_and_date_dto import AdminDataVersionAndDateDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminMultipleTenantDataVersionsDetailsDTO(BaseModel): + """ + AdminMultipleTenantDataVersionsDetailsDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The owner of the data versions.", alias="tenantCode") + data_versions: Optional[List[AdminDataVersionAndDateDTO]] = Field(default=None, description="The latest enabled data versions for the given analytic tenant. If the analytic tenant has no enabled data versions, an empty string \"\" is returned.", alias="dataVersions") + __properties: ClassVar[List[str]] = ["tenantCode", "dataVersions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminMultipleTenantDataVersionsDetailsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_versions (list) + _items = [] + if self.data_versions: + for _item_data_versions in self.data_versions: + if _item_data_versions: + _items.append(_item_data_versions.to_dict()) + _dict['dataVersions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminMultipleTenantDataVersionsDetailsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "dataVersions": [AdminDataVersionAndDateDTO.from_dict(_item) for _item in obj["dataVersions"]] if obj.get("dataVersions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_multiple_tenant_data_versions_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_multiple_tenant_data_versions_list_dto.py new file mode 100644 index 0000000000..9444caa503 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_multiple_tenant_data_versions_list_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_multiple_tenant_data_versions_details_dto import AdminMultipleTenantDataVersionsDetailsDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminMultipleTenantDataVersionsListDTO(BaseModel): + """ + AdminMultipleTenantDataVersionsListDTO + """ # noqa: E501 + tenants: Optional[List[AdminMultipleTenantDataVersionsDetailsDTO]] = Field(default=None, description="A list of analytic tenants and their latest enabled data versions.") + limit: Optional[StrictInt] = Field(default=None, description="The number of analytic tenants to retrieve. The maximum number to retrieve is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving results from, also known as offset. The index begins at 0.") + __properties: ClassVar[List[str]] = ["tenants", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminMultipleTenantDataVersionsListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminMultipleTenantDataVersionsListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [AdminMultipleTenantDataVersionsDetailsDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_network_subnets_message_request.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_network_subnets_message_request.py new file mode 100644 index 0000000000..cbec68bb12 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_network_subnets_message_request.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminNetworkSubnetsMessageRequest(BaseModel): + """ + The IP addresses to modify in the API network subnet allowlist. + """ # noqa: E501 + network_subnets_for_api: Optional[List[StrictStr]] = Field(default=None, description="The IP addresses in the request.", alias="networkSubnetsForApi") + confirm_lockout: Optional[StrictBool] = Field(default=None, description="If `true`, you acknowledge that the API call removes your IP address from the list of allowed network subnets and you will not be able to call Visier APIs from your current IP address. Default is `false`. To avoid this, add your current IP address to the allowed network subnets list.", alias="confirmLockout") + __properties: ClassVar[List[str]] = ["networkSubnetsForApi", "confirmLockout"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminNetworkSubnetsMessageRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminNetworkSubnetsMessageRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "networkSubnetsForApi": obj.get("networkSubnetsForApi"), + "confirmLockout": obj.get("confirmLockout") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_network_subnets_message_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_network_subnets_message_response.py new file mode 100644 index 0000000000..0340de322e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_network_subnets_message_response.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminNetworkSubnetsMessageResponse(BaseModel): + """ + The list of IP addresses that are allowed to call Visier APIs. + """ # noqa: E501 + network_subnets_for_api: Optional[List[StrictStr]] = Field(default=None, description="The IP addresses that are allowed to call Visier APIs.", alias="networkSubnetsForApi") + __properties: ClassVar[List[str]] = ["networkSubnetsForApi"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminNetworkSubnetsMessageResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminNetworkSubnetsMessageResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "networkSubnetsForApi": obj.get("networkSubnetsForApi") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_permission_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_permission_response_dto.py new file mode 100644 index 0000000000..c33b2e0a53 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_permission_response_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminPermissionResponseDTO(BaseModel): + """ + AdminPermissionResponseDTO + """ # noqa: E501 + permission_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the permission.", alias="permissionId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable permission name to display in Visier, such as \"Diversity Access\".", alias="displayName") + __properties: ClassVar[List[str]] = ["permissionId", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminPermissionResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminPermissionResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissionId": obj.get("permissionId"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_list_dto.py new file mode 100644 index 0000000000..e4a4e37a28 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_list_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_permission_dto import ServicingPermissionDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminPermissionsListDTO(BaseModel): + """ + AdminPermissionsListDTO + """ # noqa: E501 + permissions: Optional[List[ServicingPermissionDTO]] = Field(default=None, description="The list of permissions that will be created or updated") + __properties: ClassVar[List[str]] = ["permissions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminPermissionsListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminPermissionsListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": [ServicingPermissionDTO.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_to_user_group_for_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_to_user_group_for_tenant_dto.py new file mode 100644 index 0000000000..e38acd01cd --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_to_user_group_for_tenant_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_group_get_api_response_dto import AdminUserGroupGetAPIResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminPermissionsToUserGroupForTenantDTO(BaseModel): + """ + AdminPermissionsToUserGroupForTenantDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the tenant.", alias="tenantCode") + status: Optional[StrictStr] = Field(default=None, description="The state of the permission assignment or removal. Valid values are Succeed or Failed.") + message: Optional[StrictStr] = Field(default=None, description="A detailed description of the request outcome, if available.") + user_groups: Optional[List[AdminUserGroupGetAPIResponseDTO]] = Field(default=None, description="A list of objects representing user groups and the permissions to assign to or remove from them.", alias="userGroups") + __properties: ClassVar[List[str]] = ["tenantCode", "status", "message", "userGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminPermissionsToUserGroupForTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminPermissionsToUserGroupForTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "status": obj.get("status"), + "message": obj.get("message"), + "userGroups": [AdminUserGroupGetAPIResponseDTO.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_to_user_group_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_to_user_group_request_dto.py new file mode 100644 index 0000000000..825993db3b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_to_user_group_request_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminPermissionsToUserGroupRequestDTO(BaseModel): + """ + AdminPermissionsToUserGroupRequestDTO + """ # noqa: E501 + user_group_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user group.", alias="userGroupId") + permissions_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing the unique permission IDs to assign.", alias="permissionsIds") + __properties: ClassVar[List[str]] = ["userGroupId", "permissionsIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminPermissionsToUserGroupRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminPermissionsToUserGroupRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroupId": obj.get("userGroupId"), + "permissionsIds": obj.get("permissionsIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_to_user_groups_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_to_user_groups_request_dto.py new file mode 100644 index 0000000000..a880bff2ea --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_permissions_to_user_groups_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_permissions_to_user_group_request_dto import AdminPermissionsToUserGroupRequestDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminPermissionsToUserGroupsRequestDTO(BaseModel): + """ + AdminPermissionsToUserGroupsRequestDTO + """ # noqa: E501 + user_groups: Optional[List[AdminPermissionsToUserGroupRequestDTO]] = Field(default=None, description="A list of objects representing the user groups and permissions to assign or remove.", alias="userGroups") + __properties: ClassVar[List[str]] = ["userGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminPermissionsToUserGroupsRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminPermissionsToUserGroupsRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroups": [AdminPermissionsToUserGroupRequestDTO.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_release_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_release_dto.py new file mode 100644 index 0000000000..afd3e158be --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_release_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminProductReleaseDTO(BaseModel): + """ + Details about the available release versions for a specific product. + """ # noqa: E501 + product_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the product.", alias="productId") + previous_version: Optional[StrictStr] = Field(default=None, description="The release version being replaced by the latest version.", alias="previousVersion") + previous_version_end_date: Optional[StrictStr] = Field(default=None, description="The end-of-life date for the previous release version. Once this date has passed, the latest version will be automatically activated on all tenants. The format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.", alias="previousVersionEndDate") + latest_version: Optional[StrictStr] = Field(default=None, description="The release version that replaces previous versions.", alias="latestVersion") + __properties: ClassVar[List[str]] = ["productId", "previousVersion", "previousVersionEndDate", "latestVersion"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminProductReleaseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminProductReleaseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "productId": obj.get("productId"), + "previousVersion": obj.get("previousVersion"), + "previousVersionEndDate": obj.get("previousVersionEndDate"), + "latestVersion": obj.get("latestVersion") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_releases_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_releases_dto.py new file mode 100644 index 0000000000..720738137c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_releases_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_product_release_dto import AdminProductReleaseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminProductReleasesDTO(BaseModel): + """ + A collection of products and details about their available release versions. + """ # noqa: E501 + releases: Optional[List[AdminProductReleaseDTO]] = Field(default=None, description="A list of products and details about their available release versions.") + __properties: ClassVar[List[str]] = ["releases"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminProductReleasesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in releases (list) + _items = [] + if self.releases: + for _item_releases in self.releases: + if _item_releases: + _items.append(_item_releases.to_dict()) + _dict['releases'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminProductReleasesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "releases": [AdminProductReleaseDTO.from_dict(_item) for _item in obj["releases"]] if obj.get("releases") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_version_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_version_dto.py new file mode 100644 index 0000000000..e8ac31e448 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_version_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminProductVersionDTO(BaseModel): + """ + Provides information about the product release version of a tenant. It is used when retrieving the active product release version and activating the product release version. + """ # noqa: E501 + product_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the product.", alias="productId") + version: Optional[StrictStr] = Field(default=None, description="The release version of the product.") + tenant_codes: Optional[List[StrictStr]] = Field(default=None, description="The tenants you want to execute the API call on. Retrieve or activate the product release versions on these tenants.", alias="tenantCodes") + __properties: ClassVar[List[str]] = ["productId", "version", "tenantCodes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminProductVersionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminProductVersionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "productId": obj.get("productId"), + "version": obj.get("version"), + "tenantCodes": obj.get("tenantCodes") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_dto.py new file mode 100644 index 0000000000..5a21888d4a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_product_version_dto import AdminProductVersionDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminProductVersionsDTO(BaseModel): + """ + A collection of products and their current release version for a tenant. + """ # noqa: E501 + versions: Optional[List[AdminProductVersionDTO]] = Field(default=None, description="A list of products and their current release versions for a tenant.") + __properties: ClassVar[List[str]] = ["versions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminProductVersionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in versions (list) + _items = [] + if self.versions: + for _item_versions in self.versions: + if _item_versions: + _items.append(_item_versions.to_dict()) + _dict['versions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminProductVersionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "versions": [AdminProductVersionDTO.from_dict(_item) for _item in obj["versions"]] if obj.get("versions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_update_failure_tenant_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_update_failure_tenant_response_dto.py new file mode 100644 index 0000000000..2b6e1ed6ce --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_update_failure_tenant_response_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminProductVersionsUpdateFailureTenantResponseDTO(BaseModel): + """ + Provides details about the failed activation of a product release version. + """ # noqa: E501 + product_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the product that failed to activate.", alias="productId") + version: Optional[StrictStr] = Field(default=None, description="The release version of the product that was being activated.") + tenant_codes: Optional[List[StrictStr]] = Field(default=None, description="The tenants where the specified release version failed to activate.", alias="tenantCodes") + message: Optional[StrictStr] = Field(default=None, description="More information about why the activation failed.") + __properties: ClassVar[List[str]] = ["productId", "version", "tenantCodes", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminProductVersionsUpdateFailureTenantResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminProductVersionsUpdateFailureTenantResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "productId": obj.get("productId"), + "version": obj.get("version"), + "tenantCodes": obj.get("tenantCodes"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_update_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_update_response_dto.py new file mode 100644 index 0000000000..1cd083742d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_update_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_product_versions_update_failure_tenant_response_dto import AdminProductVersionsUpdateFailureTenantResponseDTO +from visier_platform_sdk.models.admin_product_versions_update_successful_tenant_response_dto import AdminProductVersionsUpdateSuccessfulTenantResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminProductVersionsUpdateResponseDTO(BaseModel): + """ + A collection of responses indicating the success or failure of a product release version activation request, including lists of tenants with successful or failed activations. + """ # noqa: E501 + successes: Optional[List[AdminProductVersionsUpdateSuccessfulTenantResponseDTO]] = Field(default=None, description="The products that were successfully activated.") + failures: Optional[List[AdminProductVersionsUpdateFailureTenantResponseDTO]] = Field(default=None, description="The products that failed to activate.") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminProductVersionsUpdateResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminProductVersionsUpdateResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [AdminProductVersionsUpdateSuccessfulTenantResponseDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [AdminProductVersionsUpdateFailureTenantResponseDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_update_successful_tenant_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_update_successful_tenant_response_dto.py new file mode 100644 index 0000000000..59355b8b1b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_product_versions_update_successful_tenant_response_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminProductVersionsUpdateSuccessfulTenantResponseDTO(BaseModel): + """ + Provides confirmation details about the successful activation of a product release version. + """ # noqa: E501 + product_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the product that was successfully activated.", alias="productId") + version: Optional[StrictStr] = Field(default=None, description="The release version of the product that was activated.") + tenant_codes: Optional[List[StrictStr]] = Field(default=None, description="The tenants where the specified release version was succesfully activated.", alias="tenantCodes") + __properties: ClassVar[List[str]] = ["productId", "version", "tenantCodes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminProductVersionsUpdateSuccessfulTenantResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminProductVersionsUpdateSuccessfulTenantResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "productId": obj.get("productId"), + "version": obj.get("version"), + "tenantCodes": obj.get("tenantCodes") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_put_project_commits_request.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_put_project_commits_request.py new file mode 100644 index 0000000000..a3f6439a08 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_put_project_commits_request.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminPutProjectCommitsRequest(BaseModel): + """ + AdminPutProjectCommitsRequest + """ # noqa: E501 + project_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the draft project you want to import committed changes into.", alias="projectId") + __properties: ClassVar[List[str]] = ["projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminPutProjectCommitsRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminPutProjectCommitsRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_security_assignment_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_security_assignment_response_dto.py new file mode 100644 index 0000000000..c14306b8e7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_security_assignment_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_tenant_assignments_dto import AdminTenantAssignmentsDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminSecurityAssignmentResponseDTO(BaseModel): + """ + AdminSecurityAssignmentResponseDTO + """ # noqa: E501 + tenants: Optional[List[AdminTenantAssignmentsDTO]] = Field(default=None, description="A list of objects representing the tenants and users that were assigned to or removed from user groups.") + __properties: ClassVar[List[str]] = ["tenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminSecurityAssignmentResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminSecurityAssignmentResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [AdminTenantAssignmentsDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_setting_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_setting_request_dto.py new file mode 100644 index 0000000000..d5f6c67543 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_setting_request_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_tenant_connector_settings_request_dto import AdminTenantConnectorSettingsRequestDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminSetConnectorSettingRequestDTO(BaseModel): + """ + AdminSetConnectorSettingRequestDTO + """ # noqa: E501 + connector_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the data connector.", alias="connectorId") + tenants: Optional[List[AdminTenantConnectorSettingsRequestDTO]] = Field(default=None, description="The tenant codes and data connector settings to update.") + __properties: ClassVar[List[str]] = ["connectorId", "tenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminSetConnectorSettingRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminSetConnectorSettingRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connectorId": obj.get("connectorId"), + "tenants": [AdminTenantConnectorSettingsRequestDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_setting_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_setting_response_dto.py new file mode 100644 index 0000000000..060b913378 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_setting_response_dto.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_connector_settings_response_dto import AdminConnectorSettingsResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminSetConnectorSettingResponseDTO(BaseModel): + """ + AdminSetConnectorSettingResponseDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the tenant.", alias="tenantCode") + connectors: Optional[List[AdminConnectorSettingsResponseDTO]] = Field(default=None, description="A list of objects representing the assigned settings and connectors.") + status: Optional[StrictStr] = Field(default=None, description="The state of the setting assignment. Valid values are Succeed or Failed.") + message: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["tenantCode", "connectors", "status", "message"] + + @field_validator('status') + def status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unknown', 'Succeed', 'Failed']): + raise ValueError("must be one of enum values ('Unknown', 'Succeed', 'Failed')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminSetConnectorSettingResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connectors (list) + _items = [] + if self.connectors: + for _item_connectors in self.connectors: + if _item_connectors: + _items.append(_item_connectors.to_dict()) + _dict['connectors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminSetConnectorSettingResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "connectors": [AdminConnectorSettingsResponseDTO.from_dict(_item) for _item in obj["connectors"]] if obj.get("connectors") is not None else None, + "status": obj.get("status"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_settings_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_settings_request_dto.py new file mode 100644 index 0000000000..b5fff7a375 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_settings_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_set_connector_setting_request_dto import AdminSetConnectorSettingRequestDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminSetConnectorSettingsRequestDTO(BaseModel): + """ + AdminSetConnectorSettingsRequestDTO + """ # noqa: E501 + connectors: Optional[List[AdminSetConnectorSettingRequestDTO]] = Field(default=None, description="The settings to define for each data connector and tenant.") + __properties: ClassVar[List[str]] = ["connectors"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminSetConnectorSettingsRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connectors (list) + _items = [] + if self.connectors: + for _item_connectors in self.connectors: + if _item_connectors: + _items.append(_item_connectors.to_dict()) + _dict['connectors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminSetConnectorSettingsRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connectors": [AdminSetConnectorSettingRequestDTO.from_dict(_item) for _item in obj["connectors"]] if obj.get("connectors") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_settings_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_settings_response_dto.py new file mode 100644 index 0000000000..f40ed4338f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_set_connector_settings_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_set_connector_setting_response_dto import AdminSetConnectorSettingResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminSetConnectorSettingsResponseDTO(BaseModel): + """ + AdminSetConnectorSettingsResponseDTO + """ # noqa: E501 + tenants: Optional[List[AdminSetConnectorSettingResponseDTO]] = Field(default=None, description="The tenants and data connectors that were updated in the API request.") + __properties: ClassVar[List[str]] = ["tenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminSetConnectorSettingsResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminSetConnectorSettingsResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [AdminSetConnectorSettingResponseDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_simple_user_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_simple_user_dto.py new file mode 100644 index 0000000000..365fc15fa2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_simple_user_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminSimpleUserDTO(BaseModel): + """ + AdminSimpleUserDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user.", alias="userId") + username: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@visier.com.") + __properties: ClassVar[List[str]] = ["userId", "username"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminSimpleUserDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminSimpleUserDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "username": obj.get("username") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_target_project_for_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_target_project_for_tenant_dto.py new file mode 100644 index 0000000000..75cf365683 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_target_project_for_tenant_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminTargetProjectForTenantDTO(BaseModel): + """ + AdminTargetProjectForTenantDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project in which to make changes for the tenant.", alias="projectId") + __properties: ClassVar[List[str]] = ["tenantCode", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTargetProjectForTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTargetProjectForTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_target_project_for_tenants_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_target_project_for_tenants_list_dto.py new file mode 100644 index 0000000000..68922b949c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_target_project_for_tenants_list_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_target_project_for_tenant_dto import AdminTargetProjectForTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminTargetProjectForTenantsListDTO(BaseModel): + """ + AdminTargetProjectForTenantsListDTO + """ # noqa: E501 + target_project_for_tenants: Optional[List[AdminTargetProjectForTenantDTO]] = Field(default=None, description="Administrating tenants can specify the tenants and projects in which to make assignments to users. Specify one `projectId` per `tenantCode`. If omitted, the request is immediately published to production or applied to the `ProjectID` in the request header, if available, for the administrating tenant or TargetTenantID, if available.", alias="targetProjectForTenants") + __properties: ClassVar[List[str]] = ["targetProjectForTenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTargetProjectForTenantsListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in target_project_for_tenants (list) + _items = [] + if self.target_project_for_tenants: + for _item_target_project_for_tenants in self.target_project_for_tenants: + if _item_target_project_for_tenants: + _items.append(_item_target_project_for_tenants.to_dict()) + _dict['targetProjectForTenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTargetProjectForTenantsListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "targetProjectForTenants": [AdminTargetProjectForTenantDTO.from_dict(_item) for _item in obj["targetProjectForTenants"]] if obj.get("targetProjectForTenants") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_assignments_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_assignments_dto.py new file mode 100644 index 0000000000..9b091abcf4 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_assignments_dto.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_security_assignments_dto import AdminUserSecurityAssignmentsDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantAssignmentsDTO(BaseModel): + """ + AdminTenantAssignmentsDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the tenant.", alias="tenantCode") + status: Optional[StrictStr] = Field(default=None, description="The state of the user group assignment. Valid values are Succeed or Failed.") + message: Optional[StrictStr] = Field(default=None, description="A detailed description of the request outcome, if available.") + assignments: Optional[List[AdminUserSecurityAssignmentsDTO]] = Field(default=None, description="A list of objects representing the user group and user assignments.") + project_id: Optional[StrictStr] = Field(default=None, description="The ID of the project that the change was made in, if applicable.", alias="projectId") + __properties: ClassVar[List[str]] = ["tenantCode", "status", "message", "assignments", "projectId"] + + @field_validator('status') + def status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unknown', 'Succeed', 'Failed']): + raise ValueError("must be one of enum values ('Unknown', 'Succeed', 'Failed')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantAssignmentsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in assignments (list) + _items = [] + if self.assignments: + for _item_assignments in self.assignments: + if _item_assignments: + _items.append(_item_assignments.to_dict()) + _dict['assignments'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantAssignmentsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "status": obj.get("status"), + "message": obj.get("message"), + "assignments": [AdminUserSecurityAssignmentsDTO.from_dict(_item) for _item in obj["assignments"]] if obj.get("assignments") is not None else None, + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_code_body.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_code_body.py new file mode 100644 index 0000000000..86f20680ee --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_code_body.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantCodeBody(BaseModel): + """ + AdminTenantCodeBody + """ # noqa: E501 + tenant_codes: Optional[List[StrictStr]] = Field(default=None, description="A list of a CA tenant's source tenants codes. The maximum length is 1000.", alias="tenantCodes") + __properties: ClassVar[List[str]] = ["tenantCodes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantCodeBody from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantCodeBody from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCodes": obj.get("tenantCodes") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_connector_settings_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_connector_settings_request_dto.py new file mode 100644 index 0000000000..ed2359eb46 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_connector_settings_request_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_connector_setting_request_dto import AdminConnectorSettingRequestDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantConnectorSettingsRequestDTO(BaseModel): + """ + AdminTenantConnectorSettingsRequestDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the tenant.", alias="tenantCode") + connector_settings: Optional[List[AdminConnectorSettingRequestDTO]] = Field(default=None, description="The settings to update.", alias="connectorSettings") + __properties: ClassVar[List[str]] = ["tenantCode", "connectorSettings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantConnectorSettingsRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connector_settings (list) + _items = [] + if self.connector_settings: + for _item_connector_settings in self.connector_settings: + if _item_connector_settings: + _items.append(_item_connector_settings.to_dict()) + _dict['connectorSettings'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantConnectorSettingsRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "connectorSettings": [AdminConnectorSettingRequestDTO.from_dict(_item) for _item in obj["connectorSettings"]] if obj.get("connectorSettings") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_detail_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_detail_apidto.py new file mode 100644 index 0000000000..cf0bd0926e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_detail_apidto.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_custom_tenant_property_dto import AdminCustomTenantPropertyDTO +from visier_platform_sdk.models.designer_tenant_module_dto import DesignerTenantModuleDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantDetailAPIDTO(BaseModel): + """ + AdminTenantDetailAPIDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant. For example, \"WFF_j1r~i1o\".", alias="tenantCode") + tenant_display_name: Optional[StrictStr] = Field(default=None, description="An identifiable tenant name that is displayed within Visier. For example, \"Callisto\".", alias="tenantDisplayName") + status: Optional[StrictStr] = Field(default=None, description="Whether the tenant is enabled or disabled.") + provision_date: Optional[StrictStr] = Field(default=None, description="The date that the tenant was created.", alias="provisionDate") + current_data_version: Optional[StrictStr] = Field(default=None, description="The data version ID that the tenant is using.", alias="currentDataVersion") + data_version_date: Optional[StrictStr] = Field(default=None, description="The date that the data version was published to production.", alias="dataVersionDate") + modules: Optional[List[DesignerTenantModuleDTO]] = Field(default=None, description="The modules assigned to the analytic tenant.") + industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs.", alias="industryCode") + can_administer_other_tenants: Optional[StrictBool] = Field(default=None, description="If true, the tenant is an administrating tenant.", alias="canAdministerOtherTenants") + embeddable_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded.", alias="embeddableDomains") + custom_properties: Optional[List[AdminCustomTenantPropertyDTO]] = Field(default=None, description="A set of key-value pairs that represent different customizable properties for the analytic tenant.", alias="customProperties") + sso_instance_issuers: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant.", alias="ssoInstanceIssuers") + vanity_url_name: Optional[StrictStr] = Field(default=None, description="The name of the administrating tenant used in Visier URLs.", alias="vanityUrlName") + allowed_o_auth_idp_url_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, which can be used as values for the idp_url parameter", alias="allowedOAuthIdpUrlDomains") + __properties: ClassVar[List[str]] = ["tenantCode", "tenantDisplayName", "status", "provisionDate", "currentDataVersion", "dataVersionDate", "modules", "industryCode", "canAdministerOtherTenants", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "vanityUrlName", "allowedOAuthIdpUrlDomains"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantDetailAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in modules (list) + _items = [] + if self.modules: + for _item_modules in self.modules: + if _item_modules: + _items.append(_item_modules.to_dict()) + _dict['modules'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_properties (list) + _items = [] + if self.custom_properties: + for _item_custom_properties in self.custom_properties: + if _item_custom_properties: + _items.append(_item_custom_properties.to_dict()) + _dict['customProperties'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantDetailAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "tenantDisplayName": obj.get("tenantDisplayName"), + "status": obj.get("status"), + "provisionDate": obj.get("provisionDate"), + "currentDataVersion": obj.get("currentDataVersion"), + "dataVersionDate": obj.get("dataVersionDate"), + "modules": [DesignerTenantModuleDTO.from_dict(_item) for _item in obj["modules"]] if obj.get("modules") is not None else None, + "industryCode": obj.get("industryCode"), + "canAdministerOtherTenants": obj.get("canAdministerOtherTenants"), + "embeddableDomains": obj.get("embeddableDomains"), + "customProperties": [AdminCustomTenantPropertyDTO.from_dict(_item) for _item in obj["customProperties"]] if obj.get("customProperties") is not None else None, + "ssoInstanceIssuers": obj.get("ssoInstanceIssuers"), + "vanityUrlName": obj.get("vanityUrlName"), + "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_details_traits_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_details_traits_dto.py new file mode 100644 index 0000000000..20b1be785d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_details_traits_dto.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantDetailsTraitsDTO(BaseModel): + """ + The tenant's traits, including aggregation rights, tenant type, and data profile type. + """ # noqa: E501 + aggregation_rights: Optional[StrictBool] = Field(default=None, description="If `true`, the tenant is opted in to Visier's data aggregation program, such as Visier Benchmarks. Default is `false`. If `false`, `aggregationRights` isn't returned in the response.", alias="aggregationRights") + tenant_type: Optional[StrictStr] = Field(default=None, description="The tenant's type. Valid values: * `ENTERPRISE`: An analytic tenant managed by Visier that represents an enterprise customer's instance of Visier. * `PARTNER`: An administrating tenant that manages one or more analytic tenants. Partner tenants are managed by non-Visier administrators, such as an embedded partner or system integration partner. * `PARTNER_CUSTOMER`: An analytic tenant managed by a partner that represents the partner's customer's instance of Visier.", alias="tenantType") + data_profile_type: Optional[StrictStr] = Field(default=None, description="The tenant's data profile, which designates how the tenant's data is used. Valid values: * `Regular`: An analytic tenant managed by Visier that represents an enterprise customer's instance of Visier. * `Integration`: A partner tenant for development, staging, and testing. * `Demo`: A Visier tenant for demonstrations and training. * `Cat`: A consolidated analytics tenant for aggregating data from multiple analytic tenants in a single tenant. * `Test`: A Visier tenant for development and testing.", alias="dataProfileType") + __properties: ClassVar[List[str]] = ["aggregationRights", "tenantType", "dataProfileType"] + + @field_validator('tenant_type') + def tenant_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ROOT_ADMIN', 'ROOT', 'BLUEPRINT', 'ENTERPRISE', 'ENTERPRISE_ROOT', 'BENCHMARK', 'PARTNER', 'PARTNER_CUSTOMER', 'SMB_BP', 'SMB_CUSTOMER', 'UNKNOWN']): + raise ValueError("must be one of enum values ('ROOT_ADMIN', 'ROOT', 'BLUEPRINT', 'ENTERPRISE', 'ENTERPRISE_ROOT', 'BENCHMARK', 'PARTNER', 'PARTNER_CUSTOMER', 'SMB_BP', 'SMB_CUSTOMER', 'UNKNOWN')") + return value + + @field_validator('data_profile_type') + def data_profile_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Regular', 'Integration', 'Demo', 'Cat', 'Test']): + raise ValueError("must be one of enum values ('Regular', 'Integration', 'Demo', 'Cat', 'Test')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantDetailsTraitsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantDetailsTraitsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "aggregationRights": obj.get("aggregationRights"), + "tenantType": obj.get("tenantType"), + "dataProfileType": obj.get("dataProfileType") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_get_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_get_response_dto.py new file mode 100644 index 0000000000..63a49f6c16 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_get_response_dto.py @@ -0,0 +1,156 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_business_location_dto import AdminBusinessLocationDTO +from visier_platform_sdk.models.admin_custom_property_dto import AdminCustomPropertyDTO +from visier_platform_sdk.models.admin_home_analysis_by_user_group_dto import AdminHomeAnalysisByUserGroupDTO +from visier_platform_sdk.models.admin_tenant_details_traits_dto import AdminTenantDetailsTraitsDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantManagementAPIGetResponseDTO(BaseModel): + """ + AdminTenantManagementAPIGetResponseDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant. For example, \"WFF_j1r~i1o\"", alias="tenantCode") + tenant_display_name: Optional[StrictStr] = Field(default=None, description="An identifiable tenant name that is displayed within Visier. For example, \"Callisto\".", alias="tenantDisplayName") + status: Optional[StrictStr] = Field(default=None, description="Whether the tenant is enabled or disabled.") + provision_date: Optional[StrictStr] = Field(default=None, description="The date that the tenant was created.", alias="provisionDate") + current_data_version: Optional[StrictStr] = Field(default=None, description="The data version ID that the tenant is using.", alias="currentDataVersion") + data_version_date: Optional[StrictStr] = Field(default=None, description="The date that the data version was published to production.", alias="dataVersionDate") + purchased_modules: Optional[List[StrictStr]] = Field(default=None, description="The modules assigned to the analytic tenant.", alias="purchasedModules") + industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs.", alias="industryCode") + primary_business_location: Optional[AdminBusinessLocationDTO] = Field(default=None, description="The primary location of operations or where business is performed. If undefined, it is omitted from the response.", alias="primaryBusinessLocation") + can_administer_other_tenants: Optional[StrictBool] = Field(default=None, description="If true, the tenant is an administrating tenant.", alias="canAdministerOtherTenants") + embeddable_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded.", alias="embeddableDomains") + custom_properties: Optional[List[AdminCustomPropertyDTO]] = Field(default=None, description="A set of key-value pairs that represent different customizable properties for the analytic tenant.", alias="customProperties") + sso_instance_issuers: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant.", alias="ssoInstanceIssuers") + vanity_url_name: Optional[StrictStr] = Field(default=None, description="The name of the administrating tenant used in Visier URLs.", alias="vanityUrlName") + home_analysis_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analysis that's displayed for this tenant when a user logs in.", alias="homeAnalysisId") + home_analysis_by_user_group: Optional[List[AdminHomeAnalysisByUserGroupDTO]] = Field(default=None, description="A list of objects representing the analysis displayed to specific user groups when users log in.", alias="homeAnalysisByUserGroup") + click_through_link: Optional[StrictStr] = Field(default=None, description="The custom URL to redirect users into your portal to see the relevant content. This URL is used for links that are shared by and with your users through the sharing capability or email content.", alias="clickThroughLink") + click_through_link_enabled: Optional[StrictStr] = Field(default=None, description="Whether the click-through link is enabled or disabled.", alias="clickThroughLinkEnabled") + default_currency: Optional[StrictStr] = Field(default=None, description="The default currency to show in the application for the tenant.", alias="defaultCurrency") + allowed_o_auth_idp_url_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, that are allowed in the idp_url OAuth parameter.", alias="allowedOAuthIdpUrlDomains") + effective_industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs. This is calculated from industry codes in the tenant's data if the tenant has business unit data. Not returned if the effective industry code cannot be calculated.", alias="effectiveIndustryCode") + company_size: Optional[StrictInt] = Field(default=None, description="The latest headcount value for the analytic tenant. Not returned if no headcount data is available.", alias="companySize") + traits: Optional[AdminTenantDetailsTraitsDTO] = Field(default=None, description="The tenant's traits, including aggregation rights, tenant type, and data profile type.") + __properties: ClassVar[List[str]] = ["tenantCode", "tenantDisplayName", "status", "provisionDate", "currentDataVersion", "dataVersionDate", "purchasedModules", "industryCode", "primaryBusinessLocation", "canAdministerOtherTenants", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "vanityUrlName", "homeAnalysisId", "homeAnalysisByUserGroup", "clickThroughLink", "clickThroughLinkEnabled", "defaultCurrency", "allowedOAuthIdpUrlDomains", "effectiveIndustryCode", "companySize", "traits"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantManagementAPIGetResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of primary_business_location + if self.primary_business_location: + _dict['primaryBusinessLocation'] = self.primary_business_location.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in custom_properties (list) + _items = [] + if self.custom_properties: + for _item_custom_properties in self.custom_properties: + if _item_custom_properties: + _items.append(_item_custom_properties.to_dict()) + _dict['customProperties'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in home_analysis_by_user_group (list) + _items = [] + if self.home_analysis_by_user_group: + for _item_home_analysis_by_user_group in self.home_analysis_by_user_group: + if _item_home_analysis_by_user_group: + _items.append(_item_home_analysis_by_user_group.to_dict()) + _dict['homeAnalysisByUserGroup'] = _items + # override the default output from pydantic by calling `to_dict()` of traits + if self.traits: + _dict['traits'] = self.traits.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantManagementAPIGetResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "tenantDisplayName": obj.get("tenantDisplayName"), + "status": obj.get("status"), + "provisionDate": obj.get("provisionDate"), + "currentDataVersion": obj.get("currentDataVersion"), + "dataVersionDate": obj.get("dataVersionDate"), + "purchasedModules": obj.get("purchasedModules"), + "industryCode": obj.get("industryCode"), + "primaryBusinessLocation": AdminBusinessLocationDTO.from_dict(obj["primaryBusinessLocation"]) if obj.get("primaryBusinessLocation") is not None else None, + "canAdministerOtherTenants": obj.get("canAdministerOtherTenants"), + "embeddableDomains": obj.get("embeddableDomains"), + "customProperties": [AdminCustomPropertyDTO.from_dict(_item) for _item in obj["customProperties"]] if obj.get("customProperties") is not None else None, + "ssoInstanceIssuers": obj.get("ssoInstanceIssuers"), + "vanityUrlName": obj.get("vanityUrlName"), + "homeAnalysisId": obj.get("homeAnalysisId"), + "homeAnalysisByUserGroup": [AdminHomeAnalysisByUserGroupDTO.from_dict(_item) for _item in obj["homeAnalysisByUserGroup"]] if obj.get("homeAnalysisByUserGroup") is not None else None, + "clickThroughLink": obj.get("clickThroughLink"), + "clickThroughLinkEnabled": obj.get("clickThroughLinkEnabled"), + "defaultCurrency": obj.get("defaultCurrency"), + "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains"), + "effectiveIndustryCode": obj.get("effectiveIndustryCode"), + "companySize": obj.get("companySize"), + "traits": AdminTenantDetailsTraitsDTO.from_dict(obj["traits"]) if obj.get("traits") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_list_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_list_response_dto.py new file mode 100644 index 0000000000..6a54edbab0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_list_response_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_tenant_management_api_get_response_dto import AdminTenantManagementAPIGetResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantManagementAPIListResponseDTO(BaseModel): + """ + AdminTenantManagementAPIListResponseDTO + """ # noqa: E501 + tenants: Optional[List[AdminTenantManagementAPIGetResponseDTO]] = Field(default=None, description="A list of objects representing all the analytic tenants.") + limit: Optional[StrictInt] = Field(default=None, description="The limit of analytic tenants to return. The maximum value is 1000. The default is 150.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving values from, also known as offset. The index begins at 0.") + __properties: ClassVar[List[str]] = ["tenants", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantManagementAPIListResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantManagementAPIListResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [AdminTenantManagementAPIGetResponseDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_update_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_update_request_dto.py new file mode 100644 index 0000000000..17b5465eae --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_update_request_dto.py @@ -0,0 +1,156 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_business_location_dto import AdminBusinessLocationDTO +from visier_platform_sdk.models.admin_custom_property_dto import AdminCustomPropertyDTO +from visier_platform_sdk.models.admin_home_analysis_by_user_group_dto import AdminHomeAnalysisByUserGroupDTO +from visier_platform_sdk.models.admin_tenant_details_traits_dto import AdminTenantDetailsTraitsDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantManagementAPIUpdateRequestDTO(BaseModel): + """ + AdminTenantManagementAPIUpdateRequestDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="A unique identifier for the newly created analytic tenant. Required if creating new tenants.", alias="tenantCode") + tenant_display_name: Optional[StrictStr] = Field(default=None, description="A new display name to assign to the analytic tenant. Required if creating new tenants.", alias="tenantDisplayName") + tenant_short_name: Optional[StrictStr] = Field(default=None, description="A new short name to assign to the tenant. Required for analytic tenants.", alias="tenantShortName") + vanity_url_name: Optional[StrictStr] = Field(default=None, description="A new vanity name to assign to the tenant. Omit for new Embedded analytic tenants.", alias="vanityUrlName") + industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs. If the code is unknown, type 0. For 2-digit codes, add trailing zeros at the end to reach 6 digits, such as 620000. Required if creating new tenants.", alias="industryCode") + primary_business_location: Optional[AdminBusinessLocationDTO] = Field(default=None, description="The primary location of operations or where business is performed. This field is optional.", alias="primaryBusinessLocation") + purchased_modules: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant. Required if creating new tenants. To get the module name: 1. In Visier, open a project and navigate to **Model > Modules**. 2. Select a module. 3. In **Basic Information**, copy the **Object name**. This is the module name.", alias="purchasedModules") + embeddable_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded. If domains at the administrating tenant level match the domains at the analytic tenant level, you do not need to include a domain for each analytic tenant. This is optional.", alias="embeddableDomains") + custom_properties: Optional[List[AdminCustomPropertyDTO]] = Field(default=None, description="A list of objects that represent different customizable properties for the analytic tenant. This is optional.", alias="customProperties") + sso_instance_issuers: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant. This is optional.", alias="ssoInstanceIssuers") + home_analysis_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analysis to display for this tenant when a user logs in. This is optional. Causes the API request to take longer because it must publish a project to production. Retrieve the ID by opening an analysis in the production version of a tenant and copying the string after the last forward slash (/) in the URL. For example: `https://jupiter.visier.com/hr/prod/appcontainer?previewId=-eZPm8xvo3SUMpD4Q5pdE-6mCj9CQ9K699XgqRGwtOxagH5x2IzDFawlWn3hYqFEfU7nP0YK9ASEzmrNfAihGg..&previewType=Production#/analytics/myanalyses/8a4c1d4f-eb61-4da0-9e5b-55bef757c30e`. The `homeAnalysisID` is `8a4c1d4f-eb61-4da0-9e5b-55bef757c30e`. Alternatively, retrieve the ID by copying the `Analysis ID` or `contentId` found by following the `Embed a Visualization` documentation.", alias="homeAnalysisId") + home_analysis_by_user_group: Optional[List[AdminHomeAnalysisByUserGroupDTO]] = Field(default=None, description="A list of objects representing the analysis to display to specific user groups when users log in. This is optional. Causes the API request to take longer because it must publish a project to production.", alias="homeAnalysisByUserGroup") + update_action: Optional[StrictStr] = Field(default=None, description="Specifies the way you want to update values. Default is MERGE. Valid values: - `MERGE`: Combine the existing values with the new values. - `REPLACE`: Remove existing values and let the new values take their place.", alias="updateAction") + enabled: Optional[StrictBool] = Field(default=None, description="If true, the tenant is enabled. Enabled tenants have access to Visier visualizations.") + click_through_link: Optional[StrictStr] = Field(default=None, description="A custom URL to redirect users into your portal to see the relevant content. This URL is used for links that are shared by and with your users through the sharing capability or email content. This is optional. Causes the API request to take longer because it must publish a project to production.", alias="clickThroughLink") + default_currency: Optional[StrictStr] = Field(default=None, description="The default currency to show in the application for the tenant.", alias="defaultCurrency") + allowed_o_auth_idp_url_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, that are allowed in the idp_url OAuth parameter. This is optional.", alias="allowedOAuthIdpUrlDomains") + traits: Optional[AdminTenantDetailsTraitsDTO] = Field(default=None, description="The tenant's traits, including aggregation rights, tenant type, and data profile type.") + __properties: ClassVar[List[str]] = ["tenantCode", "tenantDisplayName", "tenantShortName", "vanityUrlName", "industryCode", "primaryBusinessLocation", "purchasedModules", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "homeAnalysisId", "homeAnalysisByUserGroup", "updateAction", "enabled", "clickThroughLink", "defaultCurrency", "allowedOAuthIdpUrlDomains", "traits"] + + @field_validator('update_action') + def update_action_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MERGE', 'REPLACE']): + raise ValueError("must be one of enum values ('MERGE', 'REPLACE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantManagementAPIUpdateRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of primary_business_location + if self.primary_business_location: + _dict['primaryBusinessLocation'] = self.primary_business_location.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in custom_properties (list) + _items = [] + if self.custom_properties: + for _item_custom_properties in self.custom_properties: + if _item_custom_properties: + _items.append(_item_custom_properties.to_dict()) + _dict['customProperties'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in home_analysis_by_user_group (list) + _items = [] + if self.home_analysis_by_user_group: + for _item_home_analysis_by_user_group in self.home_analysis_by_user_group: + if _item_home_analysis_by_user_group: + _items.append(_item_home_analysis_by_user_group.to_dict()) + _dict['homeAnalysisByUserGroup'] = _items + # override the default output from pydantic by calling `to_dict()` of traits + if self.traits: + _dict['traits'] = self.traits.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantManagementAPIUpdateRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "tenantDisplayName": obj.get("tenantDisplayName"), + "tenantShortName": obj.get("tenantShortName"), + "vanityUrlName": obj.get("vanityUrlName"), + "industryCode": obj.get("industryCode"), + "primaryBusinessLocation": AdminBusinessLocationDTO.from_dict(obj["primaryBusinessLocation"]) if obj.get("primaryBusinessLocation") is not None else None, + "purchasedModules": obj.get("purchasedModules"), + "embeddableDomains": obj.get("embeddableDomains"), + "customProperties": [AdminCustomPropertyDTO.from_dict(_item) for _item in obj["customProperties"]] if obj.get("customProperties") is not None else None, + "ssoInstanceIssuers": obj.get("ssoInstanceIssuers"), + "homeAnalysisId": obj.get("homeAnalysisId"), + "homeAnalysisByUserGroup": [AdminHomeAnalysisByUserGroupDTO.from_dict(_item) for _item in obj["homeAnalysisByUserGroup"]] if obj.get("homeAnalysisByUserGroup") is not None else None, + "updateAction": obj.get("updateAction"), + "enabled": obj.get("enabled"), + "clickThroughLink": obj.get("clickThroughLink"), + "defaultCurrency": obj.get("defaultCurrency"), + "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains"), + "traits": AdminTenantDetailsTraitsDTO.from_dict(obj["traits"]) if obj.get("traits") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_update_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_update_response_dto.py new file mode 100644 index 0000000000..c9d102c59a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_management_api_update_response_dto.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_business_location_dto import AdminBusinessLocationDTO +from visier_platform_sdk.models.admin_custom_property_dto import AdminCustomPropertyDTO +from visier_platform_sdk.models.admin_home_analysis_by_user_group_dto import AdminHomeAnalysisByUserGroupDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantManagementAPIUpdateResponseDTO(BaseModel): + """ + AdminTenantManagementAPIUpdateResponseDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier of the newly created analytic tenant.", alias="tenantCode") + tenant_display_name: Optional[StrictStr] = Field(default=None, description="A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant.", alias="tenantDisplayName") + industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs.", alias="industryCode") + primary_business_location: Optional[AdminBusinessLocationDTO] = Field(default=None, description="The primary location of operations or where business is performed. If undefined, it is omitted from the response.", alias="primaryBusinessLocation") + purchased_modules: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant.", alias="purchasedModules") + embeddable_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded. If domains at the administrating tenant level match the domains at the analytic tenant level, you do not need to include a domain for each analytic tenant.", alias="embeddableDomains") + custom_properties: Optional[List[AdminCustomPropertyDTO]] = Field(default=None, description="A list of objects that represent different customizable properties for the analytic tenant.", alias="customProperties") + sso_instance_issuers: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant.", alias="ssoInstanceIssuers") + home_analysis_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analysis to display for this tenant when a user logs in. This is optional. Retrieve the ID by opening an analysis in the production version of a tenant and copying the string after the last forward slash (/) in the URL. For example: https://jupiter.visier.com/hr/prod/appcontainer?previewId=-eZPm8xvo3SUMpD4Q5pdE-6mCj9CQ9K699XgqRGwtOxagH5x2IzDFawlWn3hYqFEfU7nP0YK9ASEzmrNfAihGg..&previewType=Production#/analytics/myanalyses/`8a4c1d4f-eb61-4da0-9e5b-55bef757c30e`. The `homeAnalysisID` is `8a4c1d4f-eb61-4da0-9e5b-55bef757c30e`. Alternatively, retrieve the ID by copying the `Analysis ID` or `contentId` found by following the `Embed a Visualization` documentation.", alias="homeAnalysisId") + home_analysis_by_user_group: Optional[List[AdminHomeAnalysisByUserGroupDTO]] = Field(default=None, description="A list of objects representing the analysis to display to specific user groups when users log in.", alias="homeAnalysisByUserGroup") + status: Optional[StrictStr] = Field(default=None, description="Whether the tenant is enabled or disabled. Enabled tenants have access to Visier visualizations.") + click_through_link: Optional[StrictStr] = Field(default=None, description="A custom URL to redirect users into your portal to see the relevant content. This URL is used for links that are shared by and with your users through the sharing capability or email content.", alias="clickThroughLink") + vanity_url_name: Optional[StrictStr] = Field(default=None, description="The name of the administrating tenant used in Visier URLs.", alias="vanityUrlName") + default_currency: Optional[StrictStr] = Field(default=None, description="The default currency to show in the application for the tenant.", alias="defaultCurrency") + allowed_o_auth_idp_url_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, that are allowed in the idp_url OAuth parameter. This is optional.", alias="allowedOAuthIdpUrlDomains") + __properties: ClassVar[List[str]] = ["tenantCode", "tenantDisplayName", "industryCode", "primaryBusinessLocation", "purchasedModules", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "homeAnalysisId", "homeAnalysisByUserGroup", "status", "clickThroughLink", "vanityUrlName", "defaultCurrency", "allowedOAuthIdpUrlDomains"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantManagementAPIUpdateResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of primary_business_location + if self.primary_business_location: + _dict['primaryBusinessLocation'] = self.primary_business_location.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in custom_properties (list) + _items = [] + if self.custom_properties: + for _item_custom_properties in self.custom_properties: + if _item_custom_properties: + _items.append(_item_custom_properties.to_dict()) + _dict['customProperties'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in home_analysis_by_user_group (list) + _items = [] + if self.home_analysis_by_user_group: + for _item_home_analysis_by_user_group in self.home_analysis_by_user_group: + if _item_home_analysis_by_user_group: + _items.append(_item_home_analysis_by_user_group.to_dict()) + _dict['homeAnalysisByUserGroup'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantManagementAPIUpdateResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "tenantDisplayName": obj.get("tenantDisplayName"), + "industryCode": obj.get("industryCode"), + "primaryBusinessLocation": AdminBusinessLocationDTO.from_dict(obj["primaryBusinessLocation"]) if obj.get("primaryBusinessLocation") is not None else None, + "purchasedModules": obj.get("purchasedModules"), + "embeddableDomains": obj.get("embeddableDomains"), + "customProperties": [AdminCustomPropertyDTO.from_dict(_item) for _item in obj["customProperties"]] if obj.get("customProperties") is not None else None, + "ssoInstanceIssuers": obj.get("ssoInstanceIssuers"), + "homeAnalysisId": obj.get("homeAnalysisId"), + "homeAnalysisByUserGroup": [AdminHomeAnalysisByUserGroupDTO.from_dict(_item) for _item in obj["homeAnalysisByUserGroup"]] if obj.get("homeAnalysisByUserGroup") is not None else None, + "status": obj.get("status"), + "clickThroughLink": obj.get("clickThroughLink"), + "vanityUrlName": obj.get("vanityUrlName"), + "defaultCurrency": obj.get("defaultCurrency"), + "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_provision_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_provision_apidto.py new file mode 100644 index 0000000000..4e682f8fdb --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_provision_apidto.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_custom_tenant_property_dto import AdminCustomTenantPropertyDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantProvisionAPIDTO(BaseModel): + """ + AdminTenantProvisionAPIDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier of the analytic tenant.", alias="tenantCode") + tenant_display_name: Optional[StrictStr] = Field(default=None, description="The display name that is assigned to the analytic tenant.", alias="tenantDisplayName") + purchased_modules: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the Visier modules assigned to the analytic tenant.", alias="purchasedModules") + industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs. If the code is unknown, type 0. For 2-digit codes, add trailing zeros at the end to reach 6 digits, such as 620000.", alias="industryCode") + embeddable_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded. If domains at the administrating tenant level match the domains at the analytic tenant level, you do not need to include a domain for each analytic tenant.", alias="embeddableDomains") + custom_properties: Optional[List[AdminCustomTenantPropertyDTO]] = Field(default=None, description="A set of key-value pairs that represent different customizable properties for the analytic tenant.", alias="customProperties") + sso_instance_issuers: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant.", alias="ssoInstanceIssuers") + allowed_o_auth_idp_url_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, which can be used as values for the idp_url OAuth parameter.", alias="allowedOAuthIdpUrlDomains") + __properties: ClassVar[List[str]] = ["tenantCode", "tenantDisplayName", "purchasedModules", "industryCode", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "allowedOAuthIdpUrlDomains"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantProvisionAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in custom_properties (list) + _items = [] + if self.custom_properties: + for _item_custom_properties in self.custom_properties: + if _item_custom_properties: + _items.append(_item_custom_properties.to_dict()) + _dict['customProperties'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantProvisionAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "tenantDisplayName": obj.get("tenantDisplayName"), + "purchasedModules": obj.get("purchasedModules"), + "industryCode": obj.get("industryCode"), + "embeddableDomains": obj.get("embeddableDomains"), + "customProperties": [AdminCustomTenantPropertyDTO.from_dict(_item) for _item in obj["customProperties"]] if obj.get("customProperties") is not None else None, + "ssoInstanceIssuers": obj.get("ssoInstanceIssuers"), + "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_status_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_status_apidto.py new file mode 100644 index 0000000000..2d404342e0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_tenant_status_apidto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminTenantStatusAPIDTO(BaseModel): + """ + AdminTenantStatusAPIDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier for the analytic tenant.", alias="tenantCode") + status: Optional[StrictStr] = Field(default=None, description="Whether the tenant is enabled or disabled.") + tenant_display_name: Optional[StrictStr] = Field(default=None, description="The identifiable tenant name that is displayed within Visier. For example, \"Callisto\".", alias="tenantDisplayName") + can_administer_other_tenants: Optional[StrictBool] = Field(default=None, description="If true, the tenant is an administrating tenant.", alias="canAdministerOtherTenants") + __properties: ClassVar[List[str]] = ["tenantCode", "status", "tenantDisplayName", "canAdministerOtherTenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminTenantStatusAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminTenantStatusAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "status": obj.get("status"), + "tenantDisplayName": obj.get("tenantDisplayName"), + "canAdministerOtherTenants": obj.get("canAdministerOtherTenants") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_update_tenant_model.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_update_tenant_model.py new file mode 100644 index 0000000000..d505c13958 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_update_tenant_model.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminUpdateTenantModel(BaseModel): + """ + AdminUpdateTenantModel + """ # noqa: E501 + tenant_display_name: Optional[StrictStr] = Field(default=None, description="A display name that is assigned to the new analytic tenant.", alias="tenantDisplayName") + industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs. If the code is unknown, type 0. For 2-digit codes, add trailing zeros at the end to reach 6 digits, such as 620000.", alias="industryCode") + purchased_modules: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant.", alias="purchasedModules") + embeddable_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded. If domains at the administrating tenant level match the domains at the analytic tenant level, you do not need to include a domain for each analytic tenant.", alias="embeddableDomains") + custom_properties: Optional[Dict[str, StrictStr]] = Field(default=None, description="A set of key-value pairs that represent different customizable properties for the analytic tenant.", alias="customProperties") + sso_instance_issuers: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant.", alias="ssoInstanceIssuers") + __properties: ClassVar[List[str]] = ["tenantDisplayName", "industryCode", "purchasedModules", "embeddableDomains", "customProperties", "ssoInstanceIssuers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUpdateTenantModel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUpdateTenantModel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantDisplayName": obj.get("tenantDisplayName"), + "industryCode": obj.get("industryCode"), + "purchasedModules": obj.get("purchasedModules"), + "embeddableDomains": obj.get("embeddableDomains"), + "customProperties": obj.get("customProperties"), + "ssoInstanceIssuers": obj.get("ssoInstanceIssuers") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_definition_dto.py new file mode 100644 index 0000000000..9553071a92 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_definition_dto.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_element_ids_dto import AdminElementIDsDTO +from visier_platform_sdk.models.admin_user_group_change_users_dto import AdminUserGroupChangeUsersDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupChangeDefinitionDTO(BaseModel): + """ + AdminUserGroupChangeDefinitionDTO + """ # noqa: E501 + user_group_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the user group. Omit if creating a new user group.", alias="userGroupId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable user group name to display in Visier, such as \"Leadership User Group\".", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="A detailed description of the population and purpose of the user group.") + permission_ids: Optional[AdminElementIDsDTO] = Field(default=None, description="The unique identifiers of permissions assigned to members of this user group.", alias="permissionIds") + users: Optional[AdminUserGroupChangeUsersDTO] = Field(default=None, description="The users assigned to the user group. You can define user group members dynamically with `dynamicFilterDefinition` or manually with `includeAllUsers` or `manuallyIncludedIds`.") + tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant to which the user group belongs or should be created in. Omit if creating or updating user groups in the current tenant.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project ID in which to update or create the user group. If omitted and the ProjectID request header is not defined, the change is published to production immediately.", alias="projectId") + __properties: ClassVar[List[str]] = ["userGroupId", "displayName", "description", "permissionIds", "users", "tenantCode", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of permission_ids + if self.permission_ids: + _dict['permissionIds'] = self.permission_ids.to_dict() + # override the default output from pydantic by calling `to_dict()` of users + if self.users: + _dict['users'] = self.users.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroupId": obj.get("userGroupId"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "permissionIds": AdminElementIDsDTO.from_dict(obj["permissionIds"]) if obj.get("permissionIds") is not None else None, + "users": AdminUserGroupChangeUsersDTO.from_dict(obj["users"]) if obj.get("users") is not None else None, + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_dimension_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_dimension_filter_dto.py new file mode 100644 index 0000000000..e9768d93b2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_dimension_filter_dto.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_element_ids_dto import AdminElementIDsDTO +from visier_platform_sdk.models.admin_user_group_change_member_selection_dto import AdminUserGroupChangeMemberSelectionDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupChangeDimensionFilterDTO(BaseModel): + """ + AdminUserGroupChangeDimensionFilterDTO + """ # noqa: E501 + dimension_id: Optional[StrictStr] = Field(default=None, description="The object name of the dimension.", alias="dimensionId") + subject_reference_path: Optional[AdminElementIDsDTO] = Field(default=None, description="A qualifying path if the dimension is from an analytic object that references Employee. For example, use `subjectReferencePath` to create a filter on the `Employment_Start_Type` dimension from the `Employment_Start` object, which references `Employee`: `{ \"ids\": [ \"Employee\", \"Employment_Start\" ] }`.", alias="subjectReferencePath") + member_selections: Optional[List[AdminUserGroupChangeMemberSelectionDTO]] = Field(default=None, description="The dimension members to select in the dynamic filter.", alias="memberSelections") + __properties: ClassVar[List[str]] = ["dimensionId", "subjectReferencePath", "memberSelections"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeDimensionFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of subject_reference_path + if self.subject_reference_path: + _dict['subjectReferencePath'] = self.subject_reference_path.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in member_selections (list) + _items = [] + if self.member_selections: + for _item_member_selections in self.member_selections: + if _item_member_selections: + _items.append(_item_member_selections.to_dict()) + _dict['memberSelections'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeDimensionFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionId": obj.get("dimensionId"), + "subjectReferencePath": AdminElementIDsDTO.from_dict(obj["subjectReferencePath"]) if obj.get("subjectReferencePath") is not None else None, + "memberSelections": [AdminUserGroupChangeMemberSelectionDTO.from_dict(_item) for _item in obj["memberSelections"]] if obj.get("memberSelections") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_failure_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_failure_dto.py new file mode 100644 index 0000000000..185f3f7886 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_failure_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupChangeFailureDTO(BaseModel): + """ + AdminUserGroupChangeFailureDTO + """ # noqa: E501 + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the user group that couldn't be created.", alias="displayName") + message: Optional[StrictStr] = Field(default=None, description="The error message containing the cause of the failure.") + rci: Optional[StrictStr] = Field(default=None, description="The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.") + tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant for which the user group could not be created or updated.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The ID of the project in which the user group could not be created or updated.", alias="projectId") + __properties: ClassVar[List[str]] = ["displayName", "message", "rci", "tenantCode", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeFailureDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeFailureDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "displayName": obj.get("displayName"), + "message": obj.get("message"), + "rci": obj.get("rci"), + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_filter_dto.py new file mode 100644 index 0000000000..554f6ce5df --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_filter_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_group_change_dimension_filter_dto import AdminUserGroupChangeDimensionFilterDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupChangeFilterDTO(BaseModel): + """ + AdminUserGroupChangeFilterDTO + """ # noqa: E501 + filter_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the filter. Omit if creating a new filter.", alias="filterId") + analytic_object_id: Optional[StrictStr] = Field(default=None, description="The analytic object the filter applies to. Currently, the only supported analytic object is `Employee`. Default is `Employee`.", alias="analyticObjectId") + dimension_filters: Optional[List[AdminUserGroupChangeDimensionFilterDTO]] = Field(default=None, description="The dimensions in the dynamic filter.", alias="dimensionFilters") + __properties: ClassVar[List[str]] = ["filterId", "analyticObjectId", "dimensionFilters"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimension_filters (list) + _items = [] + if self.dimension_filters: + for _item_dimension_filters in self.dimension_filters: + if _item_dimension_filters: + _items.append(_item_dimension_filters.to_dict()) + _dict['dimensionFilters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "filterId": obj.get("filterId"), + "analyticObjectId": obj.get("analyticObjectId"), + "dimensionFilters": [AdminUserGroupChangeDimensionFilterDTO.from_dict(_item) for _item in obj["dimensionFilters"]] if obj.get("dimensionFilters") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_member_selection_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_member_selection_dto.py new file mode 100644 index 0000000000..b9b771b7be --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_member_selection_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupChangeMemberSelectionDTO(BaseModel): + """ + AdminUserGroupChangeMemberSelectionDTO + """ # noqa: E501 + is_excluded: Optional[StrictBool] = Field(default=None, description="If `true`, the specified member must not be defined for members of the user group.", alias="isExcluded") + name_path: Optional[List[StrictStr]] = Field(default=None, description="The name path for dimension members; for example, `[ \"North America\", \"US\", \"CA\" ]`.", alias="namePath") + __properties: ClassVar[List[str]] = ["isExcluded", "namePath"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeMemberSelectionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeMemberSelectionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "isExcluded": obj.get("isExcluded"), + "namePath": obj.get("namePath") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_response_dto.py new file mode 100644 index 0000000000..f85bfd1cd9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_group_change_failure_dto import AdminUserGroupChangeFailureDTO +from visier_platform_sdk.models.admin_user_group_change_success_dto import AdminUserGroupChangeSuccessDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupChangeResponseDTO(BaseModel): + """ + AdminUserGroupChangeResponseDTO + """ # noqa: E501 + successes: Optional[List[AdminUserGroupChangeSuccessDTO]] = Field(default=None, description="The user groups that were created.") + failures: Optional[List[AdminUserGroupChangeFailureDTO]] = Field(default=None, description="The user groups that were not created.") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [AdminUserGroupChangeSuccessDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [AdminUserGroupChangeFailureDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_success_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_success_dto.py new file mode 100644 index 0000000000..b044271c2c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_success_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupChangeSuccessDTO(BaseModel): + """ + AdminUserGroupChangeSuccessDTO + """ # noqa: E501 + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the created user group.", alias="displayName") + user_group_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the user group.", alias="userGroupId") + tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant the user group was created or updated in.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The ID of the project the user group was created or updated in.", alias="projectId") + __properties: ClassVar[List[str]] = ["displayName", "userGroupId", "tenantCode", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeSuccessDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeSuccessDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "displayName": obj.get("displayName"), + "userGroupId": obj.get("userGroupId"), + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_users_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_users_dto.py new file mode 100644 index 0000000000..e71d6d79bb --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_change_users_dto.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_element_ids_dto import AdminElementIDsDTO +from visier_platform_sdk.models.admin_user_group_filters_dto import AdminUserGroupFiltersDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupChangeUsersDTO(BaseModel): + """ + AdminUserGroupChangeUsersDTO + """ # noqa: E501 + include_all_users: Optional[StrictBool] = Field(default=None, description="If `true`, all users are included in the user group. If `true`: * You can manually exclude users with `manuallyExcludedIds`. * Cannot be combined with `manuallyIncludedIds` or `dynamicFilterDefinition`.", alias="includeAllUsers") + manually_included_ids: Optional[AdminElementIDsDTO] = Field(default=None, description="Includes specified user IDs in the user group. * May be combined with `dynamicFilterDefinition`. * Omit if `includeAllUsers` is `true`.", alias="manuallyIncludedIds") + manually_excluded_ids: Optional[AdminElementIDsDTO] = Field(default=None, description="Excludes specified user IDs from the user group. * You can manually exclude users if `includeAllUsers` is `true` or if `dynamicFilterDefinition` is defined. * Excluded IDs must not overlap with user IDs in `manuallyIncludedIds`.", alias="manuallyExcludedIds") + dynamic_filter_definition: Optional[AdminUserGroupFiltersDTO] = Field(default=None, description="The filters that dynamically define a population through dimensions or dimensions accessible through references from the analytic object. * Omit if `includeAllUsers` is `true`. * You can combine dynamic filters with manually-assigned users.", alias="dynamicFilterDefinition") + __properties: ClassVar[List[str]] = ["includeAllUsers", "manuallyIncludedIds", "manuallyExcludedIds", "dynamicFilterDefinition"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeUsersDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of manually_included_ids + if self.manually_included_ids: + _dict['manuallyIncludedIds'] = self.manually_included_ids.to_dict() + # override the default output from pydantic by calling `to_dict()` of manually_excluded_ids + if self.manually_excluded_ids: + _dict['manuallyExcludedIds'] = self.manually_excluded_ids.to_dict() + # override the default output from pydantic by calling `to_dict()` of dynamic_filter_definition + if self.dynamic_filter_definition: + _dict['dynamicFilterDefinition'] = self.dynamic_filter_definition.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupChangeUsersDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "includeAllUsers": obj.get("includeAllUsers"), + "manuallyIncludedIds": AdminElementIDsDTO.from_dict(obj["manuallyIncludedIds"]) if obj.get("manuallyIncludedIds") is not None else None, + "manuallyExcludedIds": AdminElementIDsDTO.from_dict(obj["manuallyExcludedIds"]) if obj.get("manuallyExcludedIds") is not None else None, + "dynamicFilterDefinition": AdminUserGroupFiltersDTO.from_dict(obj["dynamicFilterDefinition"]) if obj.get("dynamicFilterDefinition") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_dto.py new file mode 100644 index 0000000000..8c87445175 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupDeleteDTO(BaseModel): + """ + AdminUserGroupDeleteDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant from which to delete the user group. Omit if deleting user groups in the current tenant.", alias="tenantCode") + user_group_id: Optional[StrictStr] = Field(default=None, description="Unique identifier for the user group.", alias="userGroupId") + project_id: Optional[StrictStr] = Field(default=None, description="The project ID in which to delete the user group. If omitted and the `ProjectID` request header is not defined, the change is published to production immediately.", alias="projectId") + __properties: ClassVar[List[str]] = ["tenantCode", "userGroupId", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupDeleteDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupDeleteDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "userGroupId": obj.get("userGroupId"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_failure_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_failure_dto.py new file mode 100644 index 0000000000..f3f06720ec --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_failure_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupDeleteFailureDTO(BaseModel): + """ + AdminUserGroupDeleteFailureDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant from which the user group could not be deleted.", alias="tenantCode") + user_group_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the user group that could not be deleted.", alias="userGroupId") + message: Optional[StrictStr] = Field(default=None, description="The error message containing the cause of the failure.") + rci: Optional[StrictStr] = Field(default=None, description="The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.") + project_id: Optional[StrictStr] = Field(default=None, description="The ID of the project in which the user group could not be deleted.", alias="projectId") + __properties: ClassVar[List[str]] = ["tenantCode", "userGroupId", "message", "rci", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupDeleteFailureDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupDeleteFailureDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "userGroupId": obj.get("userGroupId"), + "message": obj.get("message"), + "rci": obj.get("rci"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_response_dto.py new file mode 100644 index 0000000000..ba3bd94748 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_group_delete_failure_dto import AdminUserGroupDeleteFailureDTO +from visier_platform_sdk.models.admin_user_group_delete_success_dto import AdminUserGroupDeleteSuccessDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupDeleteResponseDTO(BaseModel): + """ + AdminUserGroupDeleteResponseDTO + """ # noqa: E501 + successes: Optional[List[AdminUserGroupDeleteSuccessDTO]] = Field(default=None, description="The user groups that were successfully deleted.") + failures: Optional[List[AdminUserGroupDeleteFailureDTO]] = Field(default=None, description="The user groups that were not deleted successfully.") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupDeleteResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupDeleteResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [AdminUserGroupDeleteSuccessDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [AdminUserGroupDeleteFailureDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_success_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_success_dto.py new file mode 100644 index 0000000000..595121a54e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_delete_success_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupDeleteSuccessDTO(BaseModel): + """ + AdminUserGroupDeleteSuccessDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant the user group was deleted from.", alias="tenantCode") + user_group_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the user group that was deleted.", alias="userGroupId") + project_id: Optional[StrictStr] = Field(default=None, description="The ID of the project in which user group was deleted.", alias="projectId") + __properties: ClassVar[List[str]] = ["tenantCode", "userGroupId", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupDeleteSuccessDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupDeleteSuccessDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "userGroupId": obj.get("userGroupId"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_filters_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_filters_dto.py new file mode 100644 index 0000000000..35e2a368b9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_filters_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_group_change_filter_dto import AdminUserGroupChangeFilterDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupFiltersDTO(BaseModel): + """ + AdminUserGroupFiltersDTO + """ # noqa: E501 + filters: Optional[List[AdminUserGroupChangeFilterDTO]] = Field(default=None, description="The filters that define user group membership.") + __properties: ClassVar[List[str]] = ["filters"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupFiltersDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in filters (list) + _items = [] + if self.filters: + for _item_filters in self.filters: + if _item_filters: + _items.append(_item_filters.to_dict()) + _dict['filters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupFiltersDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "filters": [AdminUserGroupChangeFilterDTO.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_get_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_get_api_response_dto.py new file mode 100644 index 0000000000..bcaaf44c93 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_get_api_response_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_permission_response_dto import AdminPermissionResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupGetAPIResponseDTO(BaseModel): + """ + AdminUserGroupGetAPIResponseDTO + """ # noqa: E501 + user_group_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user group.", alias="userGroupId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable user group name to display in Visier, such as \"Leadership User Group\".", alias="displayName") + permissions: Optional[List[AdminPermissionResponseDTO]] = Field(default=None, description="A list of objects representing the user's permissions.") + __properties: ClassVar[List[str]] = ["userGroupId", "displayName", "permissions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupGetAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupGetAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroupId": obj.get("userGroupId"), + "displayName": obj.get("displayName"), + "permissions": [AdminPermissionResponseDTO.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_single_delete_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_single_delete_response_dto.py new file mode 100644 index 0000000000..f819dee0e5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_group_single_delete_response_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_group_delete_failure_dto import AdminUserGroupDeleteFailureDTO +from visier_platform_sdk.models.admin_user_group_delete_success_dto import AdminUserGroupDeleteSuccessDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupSingleDeleteResponseDTO(BaseModel): + """ + AdminUserGroupSingleDeleteResponseDTO + """ # noqa: E501 + success: Optional[AdminUserGroupDeleteSuccessDTO] = Field(default=None, description="The user group was successfully deleted.") + failure: Optional[AdminUserGroupDeleteFailureDTO] = Field(default=None, description="The user group was not successfully deleted.") + __properties: ClassVar[List[str]] = ["success", "failure"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupSingleDeleteResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of success + if self.success: + _dict['success'] = self.success.to_dict() + # override the default output from pydantic by calling `to_dict()` of failure + if self.failure: + _dict['failure'] = self.failure.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupSingleDeleteResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "success": AdminUserGroupDeleteSuccessDTO.from_dict(obj["success"]) if obj.get("success") is not None else None, + "failure": AdminUserGroupDeleteFailureDTO.from_dict(obj["failure"]) if obj.get("failure") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_change_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_change_dto.py new file mode 100644 index 0000000000..5420cfea64 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_change_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_group_change_definition_dto import AdminUserGroupChangeDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupsChangeDTO(BaseModel): + """ + AdminUserGroupsChangeDTO + """ # noqa: E501 + user_groups: Optional[List[AdminUserGroupChangeDefinitionDTO]] = Field(default=None, description="The user groups and their definitions.", alias="userGroups") + __properties: ClassVar[List[str]] = ["userGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupsChangeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupsChangeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroups": [AdminUserGroupChangeDefinitionDTO.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_delete_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_delete_request_dto.py new file mode 100644 index 0000000000..0fa0e4d294 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_delete_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_group_delete_dto import AdminUserGroupDeleteDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupsDeleteRequestDTO(BaseModel): + """ + AdminUserGroupsDeleteRequestDTO + """ # noqa: E501 + user_groups: Optional[List[AdminUserGroupDeleteDTO]] = Field(default=None, description="The user groups to delete.", alias="userGroups") + __properties: ClassVar[List[str]] = ["userGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupsDeleteRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupsDeleteRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroups": [AdminUserGroupDeleteDTO.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_get_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_get_api_response_dto.py new file mode 100644 index 0000000000..0810b7ea8c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_get_api_response_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_group_get_api_response_dto import AdminUserGroupGetAPIResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupsGetAPIResponseDTO(BaseModel): + """ + AdminUserGroupsGetAPIResponseDTO + """ # noqa: E501 + user_groups: Optional[List[AdminUserGroupGetAPIResponseDTO]] = Field(default=None, description="A list of user groups.", alias="userGroups") + limit: Optional[StrictInt] = Field(default=None, description="The number of results to return. The maximum number of users to retrieve is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving results from, also known as offset.") + __properties: ClassVar[List[str]] = ["userGroups", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupsGetAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupsGetAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroups": [AdminUserGroupGetAPIResponseDTO.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_users_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_users_dto.py new file mode 100644 index 0000000000..edbda1cba5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_users_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_user_groups_users_for_tenant_dto import AdminUserGroupsUsersForTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupsUsersDTO(BaseModel): + """ + AdminUserGroupsUsersDTO + """ # noqa: E501 + tenants: Optional[List[AdminUserGroupsUsersForTenantDTO]] = Field(default=None, description="A list of objects representing the users that are explicitly assigned to the user group, organized by the tenants the users belong to.") + limit: Optional[StrictInt] = Field(default=None, description="The limit of results to return. The maximum value is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving values from, also known as offset. The index begins at 0.") + __properties: ClassVar[List[str]] = ["tenants", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupsUsersDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupsUsersDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [AdminUserGroupsUsersForTenantDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_users_for_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_users_for_tenant_dto.py new file mode 100644 index 0000000000..e382720e95 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_groups_users_for_tenant_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_simple_user_dto import AdminSimpleUserDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserGroupsUsersForTenantDTO(BaseModel): + """ + AdminUserGroupsUsersForTenantDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the tenant.", alias="tenantCode") + users: Optional[List[AdminSimpleUserDTO]] = Field(default=None, description="A list of objects representing the users in the user group.") + __properties: ClassVar[List[str]] = ["tenantCode", "users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserGroupsUsersForTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserGroupsUsersForTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "users": [AdminSimpleUserDTO.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_security_assignments_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_security_assignments_dto.py new file mode 100644 index 0000000000..d1f74f3148 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_user_security_assignments_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_simple_user_dto import AdminSimpleUserDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUserSecurityAssignmentsDTO(BaseModel): + """ + AdminUserSecurityAssignmentsDTO + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user group.") + name: Optional[StrictStr] = Field(default=None, description="The name of the user group.") + users: Optional[List[AdminSimpleUserDTO]] = Field(default=None, description="A list of objects representing the users assigned to or removed from the user group.") + __properties: ClassVar[List[str]] = ["id", "name", "users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUserSecurityAssignmentsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUserSecurityAssignmentsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "users": [AdminSimpleUserDTO.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_users_to_user_group_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_users_to_user_group_request_dto.py new file mode 100644 index 0000000000..81927cddf6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_users_to_user_group_request_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AdminUsersToUserGroupRequestDTO(BaseModel): + """ + AdminUsersToUserGroupRequestDTO + """ # noqa: E501 + user_group_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user group.", alias="userGroupId") + user_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing unique user IDs to assign to or remove from the user group. The maximum number of `userIds` per user group is 100.", alias="userIds") + __properties: ClassVar[List[str]] = ["userGroupId", "userIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUsersToUserGroupRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUsersToUserGroupRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroupId": obj.get("userGroupId"), + "userIds": obj.get("userIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/admin_users_to_user_groups_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/admin_users_to_user_groups_request_dto.py new file mode 100644 index 0000000000..d261294f58 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/admin_users_to_user_groups_request_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_target_project_for_tenants_list_dto import AdminTargetProjectForTenantsListDTO +from visier_platform_sdk.models.admin_users_to_user_group_request_dto import AdminUsersToUserGroupRequestDTO +from typing import Optional, Set +from typing_extensions import Self + +class AdminUsersToUserGroupsRequestDTO(BaseModel): + """ + AdminUsersToUserGroupsRequestDTO + """ # noqa: E501 + user_groups: Optional[List[AdminUsersToUserGroupRequestDTO]] = Field(default=None, description="A list of objects representing the user groups and users to assign or remove.", alias="userGroups") + target_project_for_tenants_list: Optional[AdminTargetProjectForTenantsListDTO] = Field(default=None, description="Administrating tenants can specify the tenants and projects in which to assign users to user groups or remove users from user groups. Specify one `projectId` per `tenantCode`. If omitted, the request is immediately published to production or applied to the ProjectID in the request header, if available, for the administrating tenant or TargetTenantID, if available.", alias="targetProjectForTenantsList") + __properties: ClassVar[List[str]] = ["userGroups", "targetProjectForTenantsList"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AdminUsersToUserGroupsRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in user_groups (list) + _items = [] + if self.user_groups: + for _item_user_groups in self.user_groups: + if _item_user_groups: + _items.append(_item_user_groups.to_dict()) + _dict['userGroups'] = _items + # override the default output from pydantic by calling `to_dict()` of target_project_for_tenants_list + if self.target_project_for_tenants_list: + _dict['targetProjectForTenantsList'] = self.target_project_for_tenants_list.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AdminUsersToUserGroupsRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroups": [AdminUsersToUserGroupRequestDTO.from_dict(_item) for _item in obj["userGroups"]] if obj.get("userGroups") is not None else None, + "targetProjectForTenantsList": AdminTargetProjectForTenantsListDTO.from_dict(obj["targetProjectForTenantsList"]) if obj.get("targetProjectForTenantsList") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_create_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_create_request_dto.py new file mode 100644 index 0000000000..6cb02db4c6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_create_request_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonReportCreateRequestDTO(BaseModel): + """ + The request to create a new report. + """ # noqa: E501 + title: Optional[StrictStr] = Field(default=None, description="The localized title of the report.") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the report.") + __properties: ClassVar[List[str]] = ["title", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonReportCreateRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonReportCreateRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "title": obj.get("title"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_delete_success_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_delete_success_dto.py new file mode 100644 index 0000000000..65377ac386 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_delete_success_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonReportDeleteSuccessDTO(BaseModel): + """ + The report that was successfully deleted. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the deleted report.") + __properties: ClassVar[List[str]] = ["id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonReportDeleteSuccessDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonReportDeleteSuccessDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_dto.py new file mode 100644 index 0000000000..d89a1e2c7e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_dto.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonReportDTO(BaseModel): + """ + The information of a single report. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the report.") + title: Optional[StrictStr] = Field(default=None, description="The localized title of the report.") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the report.") + updated_time: Optional[StrictStr] = Field(default=None, description="The time in epoch milliseconds when the report was last updated.", alias="updatedTime") + is_published_report: Optional[StrictBool] = Field(default=None, description="If `true`, the report is published through a project.", alias="isPublishedReport") + owner: Optional[StrictStr] = Field(default=None, description="The owner of the report.") + is_owned_by_user: Optional[StrictBool] = Field(default=None, description="If `true`, you are the owner of the report.", alias="isOwnedByUser") + allowed_actions: Optional[List[StrictStr]] = Field(default=None, description="The actions that you can perform on the report. Valid values are: - `duplicate`: The user can make their own copy of this report. - `delete`: The user can delete this report. - `edit`: The user can edit this report directly. - `download`: The user can download this report as a CSV. - `share`: The user can share this report with other users or user groups.", alias="allowedActions") + link: Optional[StrictStr] = Field(default=None, description="The link to the report.") + __properties: ClassVar[List[str]] = ["id", "title", "description", "updatedTime", "isPublishedReport", "owner", "isOwnedByUser", "allowedActions", "link"] + + @field_validator('allowed_actions') + def allowed_actions_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['duplicate', 'delete', 'edit', 'download', 'share']): + raise ValueError("each list item must be one of ('duplicate', 'delete', 'edit', 'download', 'share')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonReportDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonReportDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "title": obj.get("title"), + "description": obj.get("description"), + "updatedTime": obj.get("updatedTime"), + "isPublishedReport": obj.get("isPublishedReport"), + "owner": obj.get("owner"), + "isOwnedByUser": obj.get("isOwnedByUser"), + "allowedActions": obj.get("allowedActions"), + "link": obj.get("link") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_list_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_list_response_dto.py new file mode 100644 index 0000000000..299119a54c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_report_list_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.analysis_common_report_dto import AnalysisCommonReportDTO +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonReportListResponseDTO(BaseModel): + """ + The information of all the reports you have access to in your tenant. + """ # noqa: E501 + reports: Optional[List[AnalysisCommonReportDTO]] = Field(default=None, description="A list of reports.") + __properties: ClassVar[List[str]] = ["reports"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonReportListResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in reports (list) + _items = [] + if self.reports: + for _item_reports in self.reports: + if _item_reports: + _items.append(_item_reports.to_dict()) + _dict['reports'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonReportListResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "reports": [AnalysisCommonReportDTO.from_dict(_item) for _item in obj["reports"]] if obj.get("reports") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_clarification_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_clarification_dto.py new file mode 100644 index 0000000000..81322e31f3 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_clarification_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeClarificationDTO(BaseModel): + """ + AnalysisCommonVeeClarificationDTO + """ # noqa: E501 + message: Optional[StrictStr] = Field(default=None, description="Returned if Vee needs more context to answer your question.") + questions: Optional[List[StrictStr]] = Field(default=None, description="Additional questions you can ask that are similar or related to your question.") + metrics: Optional[List[StrictStr]] = Field(default=None, description="Suggested metrics to look at that are similar or related to your question.") + dimensions: Optional[List[StrictStr]] = Field(default=None, description="Suggested dimensions to look at that are similar or related to your question.") + filters: Optional[List[StrictStr]] = Field(default=None, description="Suggested filters that could be a better fit for the data.") + attributes: Optional[List[StrictStr]] = Field(default=None, description="Suggested attributes to look at that are similar or related to your question.") + __properties: ClassVar[List[str]] = ["message", "questions", "metrics", "dimensions", "filters", "attributes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeClarificationDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeClarificationDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "questions": obj.get("questions"), + "metrics": obj.get("metrics"), + "dimensions": obj.get("dimensions"), + "filters": obj.get("filters"), + "attributes": obj.get("attributes") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_conversation_state_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_conversation_state_dto.py new file mode 100644 index 0000000000..16bc8a1df6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_conversation_state_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeConversationStateDTO(BaseModel): + """ + AnalysisCommonVeeConversationStateDTO + """ # noqa: E501 + question_state: Optional[List[StrictStr]] = Field(default=None, description="The unique identifier of the conversation with Vee.", alias="questionState") + __properties: ClassVar[List[str]] = ["questionState"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeConversationStateDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeConversationStateDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "questionState": obj.get("questionState") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_corrections_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_corrections_dto.py new file mode 100644 index 0000000000..9b870d5ee9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_corrections_dto.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.analysis_common_vee_clarification_dto import AnalysisCommonVeeClarificationDTO +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeCorrectionsDTO(BaseModel): + """ + AnalysisCommonVeeCorrectionsDTO + """ # noqa: E501 + warning: Optional[List[StrictStr]] = Field(default=None, description="A list of warnings from Vee that accompanies an unsure answer; for example, Vee might return a close match warning if Vee finds multiple employees named Adam that relate to your question.") + clarifications: Optional[List[AnalysisCommonVeeClarificationDTO]] = Field(default=None, description="A list of clarifying questions if Vee needs more context to answer your question; for example, if asking about someone named Adam, Vee might clarify which Adam by asking for Adam's email address.") + __properties: ClassVar[List[str]] = ["warning", "clarifications"] + + @field_validator('warning') + def warning_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['VEE_NO_WARNING', 'VEE_WARNING_RESPONSE_NOT_FOUND', 'VEE_WARNING_RESPONSE_LOW_CONFIDENCE', 'VEE_WARNING_RESPONSE_FOUND_CLOSE_MATCH', 'VEE_WARNING_NO_ACCESS', 'VEE_WARNING_TIME_SELECTION_ADJUSTED', 'VEE_WARNING_FILTER_DROPPED']): + raise ValueError("each list item must be one of ('VEE_NO_WARNING', 'VEE_WARNING_RESPONSE_NOT_FOUND', 'VEE_WARNING_RESPONSE_LOW_CONFIDENCE', 'VEE_WARNING_RESPONSE_FOUND_CLOSE_MATCH', 'VEE_WARNING_NO_ACCESS', 'VEE_WARNING_TIME_SELECTION_ADJUSTED', 'VEE_WARNING_FILTER_DROPPED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeCorrectionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in clarifications (list) + _items = [] + if self.clarifications: + for _item_clarifications in self.clarifications: + if _item_clarifications: + _items.append(_item_clarifications.to_dict()) + _dict['clarifications'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeCorrectionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "warning": obj.get("warning"), + "clarifications": [AnalysisCommonVeeClarificationDTO.from_dict(_item) for _item in obj["clarifications"]] if obj.get("clarifications") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_data_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_data_dto.py new file mode 100644 index 0000000000..ad0de4833a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_data_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeDataDTO(BaseModel): + """ + AnalysisCommonVeeDataDTO + """ # noqa: E501 + data_json: Optional[StrictStr] = Field(default=None, description="A JSON string of fields and numerical values representing the data contributing to Vee's answer. For example, the number of employees per gender in Vee's answer.", alias="dataJson") + context: Optional[StrictStr] = Field(default=None, description="The filter applied to the visualization generated by Vee. For example, a time filter of April 2024.") + __properties: ClassVar[List[str]] = ["dataJson", "context"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeDataDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeDataDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataJson": obj.get("dataJson"), + "context": obj.get("context") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_feedback_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_feedback_dto.py new file mode 100644 index 0000000000..069de2ff4c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_feedback_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.analysis_common_vee_response_dto import AnalysisCommonVeeResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeFeedbackDTO(BaseModel): + """ + The request body fields to submit Vee feedback. + """ # noqa: E501 + response: Optional[AnalysisCommonVeeResponseDTO] = Field(default=None, description="Your feedback about Vee's answer. Include the response object from the `/question` call that you want to provide feedback about.") + is_approved: Optional[StrictBool] = Field(default=None, description="If `true`, Vee answered the question correctly. If `false`, Vee's answer was incorrect or lacked details.", alias="isApproved") + description: Optional[StrictStr] = Field(default=None, description="A description of how Vee should have answered the question or how Vee can improve the answer; for example, \"Expected Headcount metric, but Vee returned Average Headcount\".") + __properties: ClassVar[List[str]] = ["response", "isApproved", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeFeedbackDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of response + if self.response: + _dict['response'] = self.response.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeFeedbackDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "response": AnalysisCommonVeeResponseDTO.from_dict(obj["response"]) if obj.get("response") is not None else None, + "isApproved": obj.get("isApproved"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_options_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_options_dto.py new file mode 100644 index 0000000000..d53a0cdc8e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_options_dto.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.analysis_common_vee_visual_options_dto import AnalysisCommonVeeVisualOptionsDTO +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeOptionsDTO(BaseModel): + """ + AnalysisCommonVeeOptionsDTO + """ # noqa: E501 + include_visual: Optional[StrictBool] = Field(default=None, description="If `true`, returns a base64 string-encoded PNG of a rendered visualization with Vee's answer. Default is `false`.", alias="includeVisual") + visual_options: Optional[AnalysisCommonVeeVisualOptionsDTO] = Field(default=None, description="Specify how to render the visualization.", alias="visualOptions") + include_data: Optional[StrictBool] = Field(default=None, description="If `true`, returns additional data relevant to the question, including `dataJson` (visualization data) and `context` (filters applied to the visualization). Default is `false`.", alias="includeData") + data_format: Optional[StrictStr] = Field(default=None, description="The format to return visualization data in. Valid values: `json`.", alias="dataFormat") + include_reworded_question: Optional[StrictBool] = Field(default=None, description="If `true`, returns Vee's plain language interpretation of the original question. For example, if you asked \"what is the headcount by gender in each org?\", Vee might reword the question as \"What is the gender breakdown of our workforce by organization this month?\". Default is `false`.", alias="includeRewordedQuestion") + __properties: ClassVar[List[str]] = ["includeVisual", "visualOptions", "includeData", "dataFormat", "includeRewordedQuestion"] + + @field_validator('data_format') + def data_format_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['json']): + raise ValueError("must be one of enum values ('json')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeOptionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of visual_options + if self.visual_options: + _dict['visualOptions'] = self.visual_options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeOptionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "includeVisual": obj.get("includeVisual"), + "visualOptions": AnalysisCommonVeeVisualOptionsDTO.from_dict(obj["visualOptions"]) if obj.get("visualOptions") is not None else None, + "includeData": obj.get("includeData"), + "dataFormat": obj.get("dataFormat"), + "includeRewordedQuestion": obj.get("includeRewordedQuestion") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_question_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_question_dto.py new file mode 100644 index 0000000000..7028bebb8b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_question_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.analysis_common_vee_conversation_state_dto import AnalysisCommonVeeConversationStateDTO +from visier_platform_sdk.models.analysis_common_vee_options_dto import AnalysisCommonVeeOptionsDTO +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeQuestionDTO(BaseModel): + """ + The request body fields to ask Vee a question. + """ # noqa: E501 + question: Optional[StrictStr] = Field(default=None, description="The question to ask Vee. If asking a follow-up question or continuing a conversation with Vee, specify the `conversationState` object from the question's response.") + conversation_state: Optional[AnalysisCommonVeeConversationStateDTO] = Field(default=None, description="The unique identifier of the conversation with Vee. If empty, starts a new conversation with Vee. If asking a follow-up question or continuing a conversation with Vee, specify the `conversationState` object from the question's response. To submit feedback about Vee's answer, copy the entire response into your `/feedback` call.", alias="conversationState") + options: Optional[AnalysisCommonVeeOptionsDTO] = Field(default=None, description="Options to specify how Vee should respond to a question.") + max_view_details_members: Optional[StrictInt] = Field(default=None, description="The maximum number of members to return in Detailed View.", alias="maxViewDetailsMembers") + __properties: ClassVar[List[str]] = ["question", "conversationState", "options", "maxViewDetailsMembers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeQuestionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of conversation_state + if self.conversation_state: + _dict['conversationState'] = self.conversation_state.to_dict() + # override the default output from pydantic by calling `to_dict()` of options + if self.options: + _dict['options'] = self.options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeQuestionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "question": obj.get("question"), + "conversationState": AnalysisCommonVeeConversationStateDTO.from_dict(obj["conversationState"]) if obj.get("conversationState") is not None else None, + "options": AnalysisCommonVeeOptionsDTO.from_dict(obj["options"]) if obj.get("options") is not None else None, + "maxViewDetailsMembers": obj.get("maxViewDetailsMembers") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_response_dto.py new file mode 100644 index 0000000000..a712dd40ac --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_response_dto.py @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.analysis_common_vee_conversation_state_dto import AnalysisCommonVeeConversationStateDTO +from visier_platform_sdk.models.analysis_common_vee_corrections_dto import AnalysisCommonVeeCorrectionsDTO +from visier_platform_sdk.models.analysis_common_vee_data_dto import AnalysisCommonVeeDataDTO +from visier_platform_sdk.models.analysis_common_vee_response_schema_dto import AnalysisCommonVeeResponseSchemaDTO +from visier_platform_sdk.models.analysis_common_vee_status_code_dto import AnalysisCommonVeeStatusCodeDTO +from visier_platform_sdk.models.analysis_common_vee_visual_dto import AnalysisCommonVeeVisualDTO +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeResponseDTO(BaseModel): + """ + The response after asking Vee a question. + """ # noqa: E501 + conversation_state: Optional[AnalysisCommonVeeConversationStateDTO] = Field(default=None, description="The current conversation's details. To ask a follow-up question or continue the conversation with Vee, include the `conversationState` from the response in your next `/question` call. To submit feedback about Vee's answer, copy the entire response into your `/feedback` call.", alias="conversationState") + status_code: Optional[AnalysisCommonVeeStatusCodeDTO] = Field(default=None, description="A status code indicating whether or not Vee successfully answered the question.", alias="statusCode") + narrative: Optional[StrictStr] = Field(default=None, description="Vee's answer to the question.") + chart_url: Optional[StrictStr] = Field(default=None, description="A URL to view the visualization in Visier.", alias="chartUrl") + var_schema: Optional[AnalysisCommonVeeResponseSchemaDTO] = Field(default=None, description="The metrics, dimensions, and concepts that contribute to Vee's answer.", alias="schema") + corrections: Optional[List[AnalysisCommonVeeCorrectionsDTO]] = Field(default=None, description="A list of corrections and clarifications if the question was ambiguous or Vee was unsure in the answer.") + data: Optional[AnalysisCommonVeeDataDTO] = Field(default=None, description="Returned if `includeData` is `true`. Provides additional data relevant to the question, such as the visualization data and any filters applied to the visualization.") + visual: Optional[AnalysisCommonVeeVisualDTO] = Field(default=None, description="A base64 string-encoded PNG of a visualization generated by Vee to answer a question. For example, Vee can return a Breakdown visualization if asked about the headcount in each organization.") + reworded_question: Optional[StrictStr] = Field(default=None, description="Vee's plain language interpretation of the original question. For example, if you asked \"what is the headcount by gender in each org?\", Vee might reword the question as \"What is the gender breakdown of our workforce by organization this month?\".", alias="rewordedQuestion") + __properties: ClassVar[List[str]] = ["conversationState", "statusCode", "narrative", "chartUrl", "schema", "corrections", "data", "visual", "rewordedQuestion"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of conversation_state + if self.conversation_state: + _dict['conversationState'] = self.conversation_state.to_dict() + # override the default output from pydantic by calling `to_dict()` of status_code + if self.status_code: + _dict['statusCode'] = self.status_code.to_dict() + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in corrections (list) + _items = [] + if self.corrections: + for _item_corrections in self.corrections: + if _item_corrections: + _items.append(_item_corrections.to_dict()) + _dict['corrections'] = _items + # override the default output from pydantic by calling `to_dict()` of data + if self.data: + _dict['data'] = self.data.to_dict() + # override the default output from pydantic by calling `to_dict()` of visual + if self.visual: + _dict['visual'] = self.visual.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "conversationState": AnalysisCommonVeeConversationStateDTO.from_dict(obj["conversationState"]) if obj.get("conversationState") is not None else None, + "statusCode": AnalysisCommonVeeStatusCodeDTO.from_dict(obj["statusCode"]) if obj.get("statusCode") is not None else None, + "narrative": obj.get("narrative"), + "chartUrl": obj.get("chartUrl"), + "schema": AnalysisCommonVeeResponseSchemaDTO.from_dict(obj["schema"]) if obj.get("schema") is not None else None, + "corrections": [AnalysisCommonVeeCorrectionsDTO.from_dict(_item) for _item in obj["corrections"]] if obj.get("corrections") is not None else None, + "data": AnalysisCommonVeeDataDTO.from_dict(obj["data"]) if obj.get("data") is not None else None, + "visual": AnalysisCommonVeeVisualDTO.from_dict(obj["visual"]) if obj.get("visual") is not None else None, + "rewordedQuestion": obj.get("rewordedQuestion") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_response_schema_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_response_schema_dto.py new file mode 100644 index 0000000000..e63040b94a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_response_schema_dto.py @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.analysis_common_vee_response_schema_reference_dto import AnalysisCommonVeeResponseSchemaReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeResponseSchemaDTO(BaseModel): + """ + AnalysisCommonVeeResponseSchemaDTO + """ # noqa: E501 + metrics: Optional[List[StrictStr]] = Field(default=None, description="A list of the metrics that contribute to Vee's answer.") + dimensions: Optional[List[AnalysisCommonVeeResponseSchemaReferenceDTO]] = Field(default=None, description="A list of the dimensions that contribute to Vee's answer.") + concepts: Optional[List[AnalysisCommonVeeResponseSchemaReferenceDTO]] = Field(default=None, description="A list of the concepts that contribute to Vee's answer.") + __properties: ClassVar[List[str]] = ["metrics", "dimensions", "concepts"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeResponseSchemaDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensions (list) + _items = [] + if self.dimensions: + for _item_dimensions in self.dimensions: + if _item_dimensions: + _items.append(_item_dimensions.to_dict()) + _dict['dimensions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in concepts (list) + _items = [] + if self.concepts: + for _item_concepts in self.concepts: + if _item_concepts: + _items.append(_item_concepts.to_dict()) + _dict['concepts'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeResponseSchemaDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "metrics": obj.get("metrics"), + "dimensions": [AnalysisCommonVeeResponseSchemaReferenceDTO.from_dict(_item) for _item in obj["dimensions"]] if obj.get("dimensions") is not None else None, + "concepts": [AnalysisCommonVeeResponseSchemaReferenceDTO.from_dict(_item) for _item in obj["concepts"]] if obj.get("concepts") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_response_schema_reference_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_response_schema_reference_dto.py new file mode 100644 index 0000000000..287a2f4cf2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_response_schema_reference_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeResponseSchemaReferenceDTO(BaseModel): + """ + AnalysisCommonVeeResponseSchemaReferenceDTO + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The name of an attribute in the visualization; for example, Gender.") + paths: Optional[List[StrictStr]] = Field(default=None, description="The hierarchy path of an attribute in the visualization; for example, Employee.Gender.") + __properties: ClassVar[List[str]] = ["name", "paths"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeResponseSchemaReferenceDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeResponseSchemaReferenceDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "paths": obj.get("paths") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_sample_question_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_sample_question_dto.py new file mode 100644 index 0000000000..b73f734b64 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_sample_question_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeSampleQuestionDTO(BaseModel): + """ + AnalysisCommonVeeSampleQuestionDTO + """ # noqa: E501 + question: Optional[StrictStr] = Field(default=None, description="A question in plain language.") + question_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the sample question.", alias="questionId") + category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the question category.", alias="categoryId") + is_assigned_to_user: Optional[StrictBool] = Field(default=None, description="If `true`, the sample question is assigned to at least one of the user's user groups.", alias="isAssignedToUser") + __properties: ClassVar[List[str]] = ["question", "questionId", "categoryId", "isAssignedToUser"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeSampleQuestionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeSampleQuestionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "question": obj.get("question"), + "questionId": obj.get("questionId"), + "categoryId": obj.get("categoryId"), + "isAssignedToUser": obj.get("isAssignedToUser") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_sample_question_library_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_sample_question_library_dto.py new file mode 100644 index 0000000000..17d4589bb5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_sample_question_library_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.analysis_common_vee_sample_question_dto import AnalysisCommonVeeSampleQuestionDTO +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeSampleQuestionLibraryDTO(BaseModel): + """ + A list of sample questions to ask Vee. + """ # noqa: E501 + questions: Optional[List[AnalysisCommonVeeSampleQuestionDTO]] = Field(default=None, description="A list of sample questions to help your users start using Vee.") + __properties: ClassVar[List[str]] = ["questions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeSampleQuestionLibraryDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in questions (list) + _items = [] + if self.questions: + for _item_questions in self.questions: + if _item_questions: + _items.append(_item_questions.to_dict()) + _dict['questions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeSampleQuestionLibraryDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "questions": [AnalysisCommonVeeSampleQuestionDTO.from_dict(_item) for _item in obj["questions"]] if obj.get("questions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_status_code_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_status_code_dto.py new file mode 100644 index 0000000000..003327bf91 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_status_code_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeStatusCodeDTO(BaseModel): + """ + AnalysisCommonVeeStatusCodeDTO + """ # noqa: E501 + status_code: Optional[StrictStr] = Field(default=None, description="A status code indicating whether or not Vee successfully answered the question.", alias="statusCode") + status_msg: Optional[StrictStr] = Field(default=None, description="Additional information about whether or not Vee successfully answered the question.", alias="statusMsg") + __properties: ClassVar[List[str]] = ["statusCode", "statusMsg"] + + @field_validator('status_code') + def status_code_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['UNDEFINED', 'VEE_API_SUCCESS', 'VEE_API_WARNING', 'VEE_API_ERROR']): + raise ValueError("must be one of enum values ('UNDEFINED', 'VEE_API_SUCCESS', 'VEE_API_WARNING', 'VEE_API_ERROR')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeStatusCodeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeStatusCodeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "statusCode": obj.get("statusCode"), + "statusMsg": obj.get("statusMsg") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_visual_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_visual_dto.py new file mode 100644 index 0000000000..96046111c9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_visual_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeVisualDTO(BaseModel): + """ + AnalysisCommonVeeVisualDTO + """ # noqa: E501 + image: Optional[StrictStr] = Field(default=None, description="A PNG visualization encoded in a base64 string.") + title: Optional[StrictStr] = Field(default=None, description="The visualization title.") + context: Optional[StrictStr] = Field(default=None, description="Any filters applied to the visualization. For example, a time filter of April 2024.") + __properties: ClassVar[List[str]] = ["image", "title", "context"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeVisualDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeVisualDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "image": obj.get("image"), + "title": obj.get("title"), + "context": obj.get("context") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_visual_options_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_visual_options_dto.py new file mode 100644 index 0000000000..6b1e85fd0b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/analysis_common_vee_visual_options_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AnalysisCommonVeeVisualOptionsDTO(BaseModel): + """ + AnalysisCommonVeeVisualOptionsDTO + """ # noqa: E501 + width: Optional[StrictInt] = Field(default=None, description="The pixel width of the rendered visualization. Default is 600. Valid values are between 160 and 1600.") + height: Optional[StrictInt] = Field(default=None, description="The pixel height of the rendered visualization. Default is 338. Valid values are between 90 and 900.") + __properties: ClassVar[List[str]] = ["width", "height"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeVisualOptionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AnalysisCommonVeeVisualOptionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "width": obj.get("width"), + "height": obj.get("height") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/api_error.py b/src/visier_platform_sdk/visier_platform_sdk/models/api_error.py new file mode 100644 index 0000000000..dc3790909f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/api_error.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ApiError(BaseModel): + """ + Description of an API error. + """ # noqa: E501 + error_code: StrictStr = Field(description="A brief identifier of the type of error. ", alias="errorCode") + message: StrictStr = Field(description="The details of the error. ") + rci: StrictStr = Field(description="A root cause identifier that allows Visier to determine the source of the problem. ") + __properties: ClassVar[List[str]] = ["errorCode", "message", "rci"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ApiError from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ApiError from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "errorCode": obj.get("errorCode"), + "message": obj.get("message"), + "rci": obj.get("rci") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_info_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_info_dto.py new file mode 100644 index 0000000000..469c6e2f7e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_info_dto.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.authentication_o_auth2_user_subnet_info_dto import AuthenticationOAuth2UserSubnetInfoDTO +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_details_dto import AuthenticationOAuth2UserTenantDetailsDTO +from visier_platform_sdk.models.servicing_servicing_capability_proto_enum_access_lookup_dto import ServicingServicingCapabilityProtoEnumAccessLookupDTO +from typing import Optional, Set +from typing_extensions import Self + +class AuthenticationOAuth2UserInfoDTO(BaseModel): + """ + Response from OAuth 2 `userinfo` endpoint. + """ # noqa: E501 + subject: Optional[StrictStr] = Field(default=None, description="The user's display name.") + name: Optional[StrictStr] = Field(default=None, description="The user's Common Name.") + email: Optional[StrictStr] = Field(default=None, description="The user's email address.") + visier_user_id: Optional[StrictStr] = Field(default=None, description="The user's unique ID.", alias="visier:user_id") + visier_capabilities: Optional[ServicingServicingCapabilityProtoEnumAccessLookupDTO] = Field(default=None, description="The user's profile capabilities.", alias="visier:capabilities") + visier_subnets: Optional[AuthenticationOAuth2UserSubnetInfoDTO] = Field(default=None, description="Subnet restrictions controlling the IP addresses from which users can access the tenant.", alias="visier:subnets") + visier_export_subnets: Optional[AuthenticationOAuth2UserSubnetInfoDTO] = Field(default=None, description="Subnet restrictions controlling the IP addresses from which data and metadata requests can be made.", alias="visier:export_subnets") + visier_tenant_details: Optional[AuthenticationOAuth2UserTenantDetailsDTO] = Field(default=None, description="Detailed information about the analytic tenant. Included in the response if `includeTenantDetail` is `true`.", alias="visier:tenant_details") + __properties: ClassVar[List[str]] = ["subject", "name", "email", "visier:user_id", "visier:capabilities", "visier:subnets", "visier:export_subnets", "visier:tenant_details"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AuthenticationOAuth2UserInfoDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of visier_capabilities + if self.visier_capabilities: + _dict['visier:capabilities'] = self.visier_capabilities.to_dict() + # override the default output from pydantic by calling `to_dict()` of visier_subnets + if self.visier_subnets: + _dict['visier:subnets'] = self.visier_subnets.to_dict() + # override the default output from pydantic by calling `to_dict()` of visier_export_subnets + if self.visier_export_subnets: + _dict['visier:export_subnets'] = self.visier_export_subnets.to_dict() + # override the default output from pydantic by calling `to_dict()` of visier_tenant_details + if self.visier_tenant_details: + _dict['visier:tenant_details'] = self.visier_tenant_details.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AuthenticationOAuth2UserInfoDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "subject": obj.get("subject"), + "name": obj.get("name"), + "email": obj.get("email"), + "visier:user_id": obj.get("visier:user_id"), + "visier:capabilities": ServicingServicingCapabilityProtoEnumAccessLookupDTO.from_dict(obj["visier:capabilities"]) if obj.get("visier:capabilities") is not None else None, + "visier:subnets": AuthenticationOAuth2UserSubnetInfoDTO.from_dict(obj["visier:subnets"]) if obj.get("visier:subnets") is not None else None, + "visier:export_subnets": AuthenticationOAuth2UserSubnetInfoDTO.from_dict(obj["visier:export_subnets"]) if obj.get("visier:export_subnets") is not None else None, + "visier:tenant_details": AuthenticationOAuth2UserTenantDetailsDTO.from_dict(obj["visier:tenant_details"]) if obj.get("visier:tenant_details") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_subnet_info_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_subnet_info_dto.py new file mode 100644 index 0000000000..50c184af6f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_subnet_info_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AuthenticationOAuth2UserSubnetInfoDTO(BaseModel): + """ + Subnet access details. + """ # noqa: E501 + access_type: Optional[StrictStr] = Field(default=None, description="The type of subnet access granted to the user. Possible values are: * `Unknown`: Could not determine subnet access details. * `All`: No subnet restrictions. * `Restricted`: Access is only granted to requests originating from the specified `subnets`. * `None`: Access is denied. Only applicable to the Data Export API.", alias="accessType") + subnets: Optional[List[StrictStr]] = Field(default=None, description="The list of trusted IP addresses from which access is granted if accessType is `Restricted`. Must be in Classless Inter-Domain Routing (CIDR) format: `xxx.xxx.xxx.xxx/xx`.") + __properties: ClassVar[List[str]] = ["accessType", "subnets"] + + @field_validator('access_type') + def access_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unknown', 'All', 'Restricted', 'None']): + raise ValueError("must be one of enum values ('Unknown', 'All', 'Restricted', 'None')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AuthenticationOAuth2UserSubnetInfoDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AuthenticationOAuth2UserSubnetInfoDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "accessType": obj.get("accessType"), + "subnets": obj.get("subnets") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_tenant_detail_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_tenant_detail_dto.py new file mode 100644 index 0000000000..2921ceaf16 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_tenant_detail_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_properties_dto import AuthenticationOAuth2UserTenantPropertiesDTO +from typing import Optional, Set +from typing_extensions import Self + +class AuthenticationOAuth2UserTenantDetailDTO(BaseModel): + """ + Tenant detail information. + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant's unique ID.", alias="tenantCode") + display_name: Optional[StrictStr] = Field(default=None, description="The tenant's display name.", alias="displayName") + properties: Optional[AuthenticationOAuth2UserTenantPropertiesDTO] = Field(default=None, description="The tenant's properties.") + __properties: ClassVar[List[str]] = ["tenantCode", "displayName", "properties"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AuthenticationOAuth2UserTenantDetailDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of properties + if self.properties: + _dict['properties'] = self.properties.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AuthenticationOAuth2UserTenantDetailDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "displayName": obj.get("displayName"), + "properties": AuthenticationOAuth2UserTenantPropertiesDTO.from_dict(obj["properties"]) if obj.get("properties") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_tenant_details_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_tenant_details_dto.py new file mode 100644 index 0000000000..42c78d0ac1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_tenant_details_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.authentication_o_auth2_user_tenant_detail_dto import AuthenticationOAuth2UserTenantDetailDTO +from typing import Optional, Set +from typing_extensions import Self + +class AuthenticationOAuth2UserTenantDetailsDTO(BaseModel): + """ + The details of all accessible analytic tenants + """ # noqa: E501 + details: Optional[List[AuthenticationOAuth2UserTenantDetailDTO]] = Field(default=None, description="The details of all accessible analytic tenants.") + __properties: ClassVar[List[str]] = ["details"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AuthenticationOAuth2UserTenantDetailsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in details (list) + _items = [] + if self.details: + for _item_details in self.details: + if _item_details: + _items.append(_item_details.to_dict()) + _dict['details'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AuthenticationOAuth2UserTenantDetailsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "details": [AuthenticationOAuth2UserTenantDetailDTO.from_dict(_item) for _item in obj["details"]] if obj.get("details") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_tenant_properties_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_tenant_properties_dto.py new file mode 100644 index 0000000000..d7ae890bad --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/authentication_o_auth2_user_tenant_properties_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class AuthenticationOAuth2UserTenantPropertiesDTO(BaseModel): + """ + Detailed information about the tenant. + """ # noqa: E501 + vanity_url_name: Optional[StrictStr] = Field(default=None, description="The tenant's vanity name.", alias="vanityUrlName") + __properties: ClassVar[List[str]] = ["vanityUrlName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AuthenticationOAuth2UserTenantPropertiesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AuthenticationOAuth2UserTenantPropertiesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "vanityUrlName": obj.get("vanityUrlName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/benchmark_info.py b/src/visier_platform_sdk/visier_platform_sdk/models/benchmark_info.py new file mode 100644 index 0000000000..f216613cd5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/benchmark_info.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class BenchmarkInfo(BaseModel): + """ + Metadata that summarizes the benchmark dataset and API such as the release date. + """ # noqa: E501 + reference_date: StrictStr = Field(description="The date that benchmark values are calculated for. ", alias="referenceDate") + release_date: StrictStr = Field(description="The date that benchmark values are released. ", alias="releaseDate") + api_release_date: StrictStr = Field(description="The date that API changes are released. ", alias="apiReleaseDate") + __properties: ClassVar[List[str]] = ["referenceDate", "releaseDate", "apiReleaseDate"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of BenchmarkInfo from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of BenchmarkInfo from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "referenceDate": obj.get("referenceDate"), + "releaseDate": obj.get("releaseDate"), + "apiReleaseDate": obj.get("apiReleaseDate") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/benchmark_value.py b/src/visier_platform_sdk/visier_platform_sdk/models/benchmark_value.py new file mode 100644 index 0000000000..065a650475 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/benchmark_value.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class BenchmarkValue(BaseModel): + """ + The compensation benchmark value. + """ # noqa: E501 + percentile10: StrictInt = Field(description="The 10th percentile base pay. ") + percentile25: StrictInt = Field(description="The 25th percentile base pay. ") + percentile50: StrictInt = Field(description="The 50th percentile base pay. ") + percentile75: StrictInt = Field(description="The 75th percentile base pay. ") + percentile90: StrictInt = Field(description="The 90th percentile base pay. ") + aligned_range_min: StrictInt = Field(description="The lower bound of salaries that are aligned with the market. ", alias="alignedRangeMin") + aligned_range_max: StrictInt = Field(description="The upper bound of salaries that are aligned with the market. ", alias="alignedRangeMax") + reference_date: StrictStr = Field(description="The date that benchmark values are calculated for. ", alias="referenceDate") + release_date: StrictStr = Field(description="The date that benchmark values are released. ", alias="releaseDate") + industry_id: StrictStr = Field(description="The industry member ID for the returned benchmarks. ", alias="industryId") + career_level_id: StrictStr = Field(description="The career level member ID for the returned benchmarks. ", alias="careerLevelId") + __properties: ClassVar[List[str]] = ["percentile10", "percentile25", "percentile50", "percentile75", "percentile90", "alignedRangeMin", "alignedRangeMax", "referenceDate", "releaseDate", "industryId", "careerLevelId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of BenchmarkValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of BenchmarkValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "percentile10": obj.get("percentile10"), + "percentile25": obj.get("percentile25"), + "percentile50": obj.get("percentile50"), + "percentile75": obj.get("percentile75"), + "percentile90": obj.get("percentile90"), + "alignedRangeMin": obj.get("alignedRangeMin"), + "alignedRangeMax": obj.get("alignedRangeMax"), + "referenceDate": obj.get("referenceDate"), + "releaseDate": obj.get("releaseDate"), + "industryId": obj.get("industryId"), + "careerLevelId": obj.get("careerLevelId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_assign_connector_credential_request.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_assign_connector_credential_request.py new file mode 100644 index 0000000000..3a5d75dd09 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_assign_connector_credential_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_connector import DataInConnector +from typing import Optional, Set +from typing_extensions import Self + +class DataInAssignConnectorCredentialRequest(BaseModel): + """ + DataInAssignConnectorCredentialRequest + """ # noqa: E501 + connectors: Optional[List[DataInConnector]] = Field(default=None, description="A list of objects representing the data connectors to be assigned with credentials.") + __properties: ClassVar[List[str]] = ["connectors"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInAssignConnectorCredentialRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connectors (list) + _items = [] + if self.connectors: + for _item_connectors in self.connectors: + if _item_connectors: + _items.append(_item_connectors.to_dict()) + _dict['connectors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInAssignConnectorCredentialRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connectors": [DataInConnector.from_dict(_item) for _item in obj["connectors"]] if obj.get("connectors") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_connector.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_connector.py new file mode 100644 index 0000000000..a27bd13004 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_connector.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_tenant_and_credential import DataInTenantAndCredential +from typing import Optional, Set +from typing_extensions import Self + +class DataInConnector(BaseModel): + """ + DataInConnector + """ # noqa: E501 + connector_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the data connector.", alias="connectorId") + tenants: Optional[List[DataInTenantAndCredential]] = Field(default=None, description="A list of analytic tenants and credentials to be assigned to the connector.") + __properties: ClassVar[List[str]] = ["connectorId", "tenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInConnector from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInConnector from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connectorId": obj.get("connectorId"), + "tenants": [DataInTenantAndCredential.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_load_request.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_load_request.py new file mode 100644 index 0000000000..3a6c90c1a0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_load_request.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_data_load_request_model import DataInDataLoadRequestModel +from typing import Optional, Set +from typing_extensions import Self + +class DataInDataLoadRequest(BaseModel): + """ + DataInDataLoadRequest + """ # noqa: E501 + model: Optional[DataInDataLoadRequestModel] = Field(default=None, description="A form body key that contains a collection of key-value pairs.") + __properties: ClassVar[List[str]] = ["model"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInDataLoadRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of model + if self.model: + _dict['model'] = self.model.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInDataLoadRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "model": DataInDataLoadRequestModel.from_dict(obj["model"]) if obj.get("model") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_load_request_model.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_load_request_model.py new file mode 100644 index 0000000000..acfc43cac9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_load_request_model.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInDataLoadRequestModel(BaseModel): + """ + DataInDataLoadRequestModel + """ # noqa: E501 + files: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of file names. Example: `\"files\": \"/path/to/file1.zip.gpg,/path/to/another/file.zip.gpg\"`") + skip_data_load: Optional[StrictBool] = Field(default=None, description="If `true`, receives the files and skips data loading. Does not generate a data version.", alias="skipDataLoad") + __properties: ClassVar[List[str]] = ["files", "skipDataLoad"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInDataLoadRequestModel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInDataLoadRequestModel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "files": obj.get("files"), + "skipDataLoad": obj.get("skipDataLoad") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_load_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_load_response.py new file mode 100644 index 0000000000..6e023e9aee --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_load_response.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInDataLoadResponse(BaseModel): + """ + DataInDataLoadResponse + """ # noqa: E501 + job_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the receiving job.", alias="jobId") + __properties: ClassVar[List[str]] = ["jobId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInDataLoadResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInDataLoadResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobId": obj.get("jobId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_transfer_result_detail.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_transfer_result_detail.py new file mode 100644 index 0000000000..a3c2e4d266 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_transfer_result_detail.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInDataTransferResultDetail(BaseModel): + """ + DataInDataTransferResultDetail + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant that data was transferred to. For example, WFF_j1r or WFF_j1r~c7o.", alias="tenantCode") + source_names: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing the sources that received a data transfer.", alias="sourceNames") + data_size: Optional[StrictStr] = Field(default=None, description="The total size of the transfer session in bytes.", alias="dataSize") + rows: Optional[StrictStr] = Field(default=None, description="The total number of rows transferred during the transfer session.") + __properties: ClassVar[List[str]] = ["tenantCode", "sourceNames", "dataSize", "rows"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInDataTransferResultDetail from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInDataTransferResultDetail from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "sourceNames": obj.get("sourceNames"), + "dataSize": obj.get("dataSize"), + "rows": obj.get("rows") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_version_object.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_version_object.py new file mode 100644 index 0000000000..b6751155fe --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_data_version_object.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInDataVersionObject(BaseModel): + """ + DataInDataVersionObject + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code for the analytic tenant that you are disabling a data version.", alias="tenantCode") + data_version: Optional[StrictStr] = Field(default=None, description="The data version to disable for a particular analytic tenant. If not specified, disables the latest enabled data version for the analytic tenant.", alias="dataVersion") + __properties: ClassVar[List[str]] = ["tenantCode", "dataVersion"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInDataVersionObject from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInDataVersionObject from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "dataVersion": obj.get("dataVersion") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_disable_dv_model.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_disable_dv_model.py new file mode 100644 index 0000000000..dd8883e697 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_disable_dv_model.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_data_version_object import DataInDataVersionObject +from typing import Optional, Set +from typing_extensions import Self + +class DataInDisableDVModel(BaseModel): + """ + DataInDisableDVModel + """ # noqa: E501 + data_version_objects: Optional[List[DataInDataVersionObject]] = Field(default=None, description="A list of objects representing the data version to disable for a particular analytic tenant. The limit of objects to include per request is 1000.", alias="dataVersionObjects") + __properties: ClassVar[List[str]] = ["dataVersionObjects"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInDisableDVModel from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_version_objects (list) + _items = [] + if self.data_version_objects: + for _item_data_version_objects in self.data_version_objects: + if _item_data_version_objects: + _items.append(_item_data_version_objects.to_dict()) + _dict['dataVersionObjects'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInDisableDVModel from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataVersionObjects": [DataInDataVersionObject.from_dict(_item) for _item in obj["dataVersionObjects"]] if obj.get("dataVersionObjects") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_disable_dv_request.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_disable_dv_request.py new file mode 100644 index 0000000000..969b6eff85 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_disable_dv_request.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_disable_dv_model import DataInDisableDVModel +from typing import Optional, Set +from typing_extensions import Self + +class DataInDisableDVRequest(BaseModel): + """ + DataInDisableDVRequest + """ # noqa: E501 + model: Optional[DataInDisableDVModel] = Field(default=None, description="A form body key that contains a collection of key-value pairs.") + __properties: ClassVar[List[str]] = ["model"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInDisableDVRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of model + if self.model: + _dict['model'] = self.model.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInDisableDVRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "model": DataInDisableDVModel.from_dict(obj["model"]) if obj.get("model") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_disable_dv_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_disable_dv_response.py new file mode 100644 index 0000000000..442dffc2f6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_disable_dv_response.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_result import DataInResult +from typing import Optional, Set +from typing_extensions import Self + +class DataInDisableDVResponse(BaseModel): + """ + DataInDisableDVResponse + """ # noqa: E501 + total_failures: Optional[StrictInt] = Field(default=None, description="The number of data versions that failed during the disabling process.", alias="totalFailures") + total_success: Optional[StrictInt] = Field(default=None, description="The number of data versions that were disabled successfully.", alias="totalSuccess") + results: Optional[List[DataInResult]] = Field(default=None, description="A list of objects representing the disabling process.") + __properties: ClassVar[List[str]] = ["totalFailures", "totalSuccess", "results"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInDisableDVResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in results (list) + _items = [] + if self.results: + for _item_results in self.results: + if _item_results: + _items.append(_item_results.to_dict()) + _dict['results'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInDisableDVResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "totalFailures": obj.get("totalFailures"), + "totalSuccess": obj.get("totalSuccess"), + "results": [DataInResult.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_dispatching_job_status_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_dispatching_job_status_response.py new file mode 100644 index 0000000000..b088c0c8cf --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_dispatching_job_status_response.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInDispatchingJobStatusResponse(BaseModel): + """ + DataInDispatchingJobStatusResponse + """ # noqa: E501 + job_id: Optional[StrictStr] = Field(default=None, description="The ID of the dispatching job that generated the extraction jobs.", alias="jobId") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant that owns the dispatching job. This is usually the administrating tenant.", alias="tenantCode") + status: Optional[StrictStr] = Field(default=None, description="The current state of the job.") + total_jobs_dispatched: Optional[StrictInt] = Field(default=None, description="The number of extraction jobs that were generated by the dispatching job.", alias="totalJobsDispatched") + __properties: ClassVar[List[str]] = ["jobId", "tenantCode", "status", "totalJobsDispatched"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInDispatchingJobStatusResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInDispatchingJobStatusResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobId": obj.get("jobId"), + "tenantCode": obj.get("tenantCode"), + "status": obj.get("status"), + "totalJobsDispatched": obj.get("totalJobsDispatched") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_exclude_data_uploads_request.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_exclude_data_uploads_request.py new file mode 100644 index 0000000000..94ff7a12a8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_exclude_data_uploads_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_upload_to_exclude import DataInUploadToExclude +from typing import Optional, Set +from typing_extensions import Self + +class DataInExcludeDataUploadsRequest(BaseModel): + """ + DataInExcludeDataUploadsRequest + """ # noqa: E501 + uploads: Optional[List[DataInUploadToExclude]] = Field(default=None, description="A list of objects representing the data uploads to exclude for a particular analytic tenant.") + __properties: ClassVar[List[str]] = ["uploads"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInExcludeDataUploadsRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in uploads (list) + _items = [] + if self.uploads: + for _item_uploads in self.uploads: + if _item_uploads: + _items.append(_item_uploads.to_dict()) + _dict['uploads'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInExcludeDataUploadsRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uploads": [DataInUploadToExclude.from_dict(_item) for _item in obj["uploads"]] if obj.get("uploads") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_extraction_job.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_extraction_job.py new file mode 100644 index 0000000000..8c5a95eedf --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_extraction_job.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInExtractionJob(BaseModel): + """ + DataInExtractionJob + """ # noqa: E501 + extraction_job_id: Optional[StrictStr] = Field(default=None, description="The ID of the extraction job.", alias="extractionJobId") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant for the extraction job.", alias="tenantCode") + status: Optional[StrictStr] = Field(default=None, description="The current state of the job. - Valid values: Pending, Running, Succeeded, Failed, Error, Cancelling, Cancelled, RolledBack, Rescheduling, Rescheduled.") + current_stage: Optional[StrictStr] = Field(default=None, description="The current stage of the job. This is not returned if the stage is \"Completed\". - Valid values: Initialize, Retrieve Main Subject, Retrieve Secondary Subjects, Retrieve Custom Subjects, Process Records, Publish Artifacts, Publish Records, Completed.", alias="currentStage") + __properties: ClassVar[List[str]] = ["extractionJobId", "tenantCode", "status", "currentStage"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInExtractionJob from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInExtractionJob from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "extractionJobId": obj.get("extractionJobId"), + "tenantCode": obj.get("tenantCode"), + "status": obj.get("status"), + "currentStage": obj.get("currentStage") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_extraction_job_and_status_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_extraction_job_and_status_response.py new file mode 100644 index 0000000000..3c1ab9b668 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_extraction_job_and_status_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_extraction_job import DataInExtractionJob +from typing import Optional, Set +from typing_extensions import Self + +class DataInExtractionJobAndStatusResponse(BaseModel): + """ + DataInExtractionJobAndStatusResponse + """ # noqa: E501 + parent_job_id: Optional[StrictStr] = Field(default=None, description="The ID of the dispatching job that generated the extraction jobs.", alias="parentJobId") + parent_tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant that owns the dispatching job. This is usually the administrating tenant.", alias="parentTenantCode") + limit: Optional[StrictInt] = Field(default=None, description="The number of extraction jobs to return. The maximum number of jobs to return is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving results from, also known as offset. The index begins at 0.") + extraction_jobs: Optional[List[DataInExtractionJob]] = Field(default=None, description="A list of extraction job information.", alias="extractionJobs") + __properties: ClassVar[List[str]] = ["parentJobId", "parentTenantCode", "limit", "start", "extractionJobs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInExtractionJobAndStatusResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in extraction_jobs (list) + _items = [] + if self.extraction_jobs: + for _item_extraction_jobs in self.extraction_jobs: + if _item_extraction_jobs: + _items.append(_item_extraction_jobs.to_dict()) + _dict['extractionJobs'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInExtractionJobAndStatusResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "parentJobId": obj.get("parentJobId"), + "parentTenantCode": obj.get("parentTenantCode"), + "limit": obj.get("limit"), + "start": obj.get("start"), + "extractionJobs": [DataInExtractionJob.from_dict(_item) for _item in obj["extractionJobs"]] if obj.get("extractionJobs") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_include_data_uploads_request.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_include_data_uploads_request.py new file mode 100644 index 0000000000..7a75b935dc --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_include_data_uploads_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_upload_to_include import DataInUploadToInclude +from typing import Optional, Set +from typing_extensions import Self + +class DataInIncludeDataUploadsRequest(BaseModel): + """ + DataInIncludeDataUploadsRequest + """ # noqa: E501 + uploads: Optional[List[DataInUploadToInclude]] = Field(default=None, description="A list of objects representing the data uploads to include for a particular analytic tenant.") + __properties: ClassVar[List[str]] = ["uploads"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInIncludeDataUploadsRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in uploads (list) + _items = [] + if self.uploads: + for _item_uploads in self.uploads: + if _item_uploads: + _items.append(_item_uploads.to_dict()) + _dict['uploads'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInIncludeDataUploadsRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uploads": [DataInUploadToInclude.from_dict(_item) for _item in obj["uploads"]] if obj.get("uploads") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_job_status_list_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_job_status_list_response.py new file mode 100644 index 0000000000..8aa0a5c454 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_job_status_list_response.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_job_status_with_start_time import DataInJobStatusWithStartTime +from typing import Optional, Set +from typing_extensions import Self + +class DataInJobStatusListResponse(BaseModel): + """ + DataInJobStatusListResponse + """ # noqa: E501 + query_start_time: Optional[StrictStr] = Field(default=None, description="The start time from which to retrieve job statuses.", alias="queryStartTime") + query_end_time: Optional[StrictStr] = Field(default=None, description="The end time from which to retrieve job statuses.", alias="queryEndTime") + job_status: Optional[List[DataInJobStatusWithStartTime]] = Field(default=None, description="The specific status to restrict the list of jobs to.", alias="jobStatus") + __properties: ClassVar[List[str]] = ["queryStartTime", "queryEndTime", "jobStatus"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInJobStatusListResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in job_status (list) + _items = [] + if self.job_status: + for _item_job_status in self.job_status: + if _item_job_status: + _items.append(_item_job_status.to_dict()) + _dict['jobStatus'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInJobStatusListResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "queryStartTime": obj.get("queryStartTime"), + "queryEndTime": obj.get("queryEndTime"), + "jobStatus": [DataInJobStatusWithStartTime.from_dict(_item) for _item in obj["jobStatus"]] if obj.get("jobStatus") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_job_status_with_start_time.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_job_status_with_start_time.py new file mode 100644 index 0000000000..63e5c67c19 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_job_status_with_start_time.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInJobStatusWithStartTime(BaseModel): + """ + DataInJobStatusWithStartTime + """ # noqa: E501 + job_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the job.", alias="jobId") + tenant: Optional[StrictStr] = Field(default=None, description="The tenant code.") + status: Optional[StrictStr] = Field(default=None, description="The status of the job, such as Running or Completed.") + job_type: Optional[StrictStr] = Field(default=None, description="The type of the job, such as a processing job or receiving job.", alias="jobType") + start_time: Optional[StrictStr] = Field(default=None, description="The time that the job started.", alias="startTime") + __properties: ClassVar[List[str]] = ["jobId", "tenant", "status", "jobType", "startTime"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInJobStatusWithStartTime from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInJobStatusWithStartTime from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobId": obj.get("jobId"), + "tenant": obj.get("tenant"), + "status": obj.get("status"), + "jobType": obj.get("jobType"), + "startTime": obj.get("startTime") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_processing_job.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_processing_job.py new file mode 100644 index 0000000000..39b9e43203 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_processing_job.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInProcessingJob(BaseModel): + """ + DataInProcessingJob + """ # noqa: E501 + job_id: Optional[StrictStr] = Field(default=None, description="The job ID of the processing job for the analytic tenant.", alias="jobId") + tenant_code: Optional[StrictStr] = Field(default=None, description="The analytic tenant code.", alias="tenantCode") + data_version: Optional[StrictStr] = Field(default=None, description="The data version associated with the processing job.", alias="dataVersion") + status: Optional[StrictStr] = Field(default=None, description="The status of the receiving job for the analytic tenant.") + message: Optional[StrictStr] = Field(default=None, description="A meaningful message about the processing job.") + __properties: ClassVar[List[str]] = ["jobId", "tenantCode", "dataVersion", "status", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInProcessingJob from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInProcessingJob from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobId": obj.get("jobId"), + "tenantCode": obj.get("tenantCode"), + "dataVersion": obj.get("dataVersion"), + "status": obj.get("status"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_processing_job_and_status_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_processing_job_and_status_response.py new file mode 100644 index 0000000000..a436144e58 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_processing_job_and_status_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_processing_job import DataInProcessingJob +from typing import Optional, Set +from typing_extensions import Self + +class DataInProcessingJobAndStatusResponse(BaseModel): + """ + DataInProcessingJobAndStatusResponse + """ # noqa: E501 + parent_job_id: Optional[StrictStr] = Field(default=None, description="The ID of the dispatching job that generated the extraction jobs.", alias="parentJobId") + parent_tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant that owns the dispatching job. This is usually the administrating tenant.", alias="parentTenantCode") + limit: Optional[StrictInt] = Field(default=None, description="The number of processing jobs to return. The maximum number of jobs to return is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving results from, also known as offset. The index begins at 0.") + processing_jobs: Optional[List[DataInProcessingJob]] = Field(default=None, description="A list of processing job information.", alias="processingJobs") + __properties: ClassVar[List[str]] = ["parentJobId", "parentTenantCode", "limit", "start", "processingJobs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInProcessingJobAndStatusResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in processing_jobs (list) + _items = [] + if self.processing_jobs: + for _item_processing_jobs in self.processing_jobs: + if _item_processing_jobs: + _items.append(_item_processing_jobs.to_dict()) + _dict['processingJobs'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInProcessingJobAndStatusResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "parentJobId": obj.get("parentJobId"), + "parentTenantCode": obj.get("parentTenantCode"), + "limit": obj.get("limit"), + "start": obj.get("start"), + "processingJobs": [DataInProcessingJob.from_dict(_item) for _item in obj["processingJobs"]] if obj.get("processingJobs") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_processing_job_status_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_processing_job_status_response.py new file mode 100644 index 0000000000..a20e5c909c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_processing_job_status_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_processing_job import DataInProcessingJob +from typing import Optional, Set +from typing_extensions import Self + +class DataInProcessingJobStatusResponse(BaseModel): + """ + DataInProcessingJobStatusResponse + """ # noqa: E501 + parent_job_id: Optional[StrictStr] = Field(default=None, description="The job ID of the receiving job that spawned this job.", alias="parentJobId") + parent_tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the receiving job that spawned this job.", alias="parentTenantCode") + limit: Optional[StrictInt] = Field(default=None, description="The limit of processing jobs to retrieve per page.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving results from, also known as offset. The index begins at 0.") + processing_jobs: Optional[List[DataInProcessingJob]] = Field(default=None, description="A list of objects representing the processing jobs to retrieve.", alias="processingJobs") + __properties: ClassVar[List[str]] = ["parentJobId", "parentTenantCode", "limit", "start", "processingJobs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInProcessingJobStatusResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in processing_jobs (list) + _items = [] + if self.processing_jobs: + for _item_processing_jobs in self.processing_jobs: + if _item_processing_jobs: + _items.append(_item_processing_jobs.to_dict()) + _dict['processingJobs'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInProcessingJobStatusResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "parentJobId": obj.get("parentJobId"), + "parentTenantCode": obj.get("parentTenantCode"), + "limit": obj.get("limit"), + "start": obj.get("start"), + "processingJobs": [DataInProcessingJob.from_dict(_item) for _item in obj["processingJobs"]] if obj.get("processingJobs") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_cancel_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_cancel_response.py new file mode 100644 index 0000000000..6b93044edc --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_cancel_response.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_data_transfer_result_detail import DataInDataTransferResultDetail +from typing import Optional, Set +from typing_extensions import Self + +class DataInPushDataCancelResponse(BaseModel): + """ + DataInPushDataCancelResponse + """ # noqa: E501 + message: Optional[StrictStr] = Field(default=None, description="A meaningful message about the transfer session.") + transfer_session_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the transfer session.", alias="transferSessionId") + data_transfer_result_details: Optional[List[DataInDataTransferResultDetail]] = Field(default=None, description="A list of objects representing the results of the transfer session.", alias="dataTransferResultDetails") + status: Optional[StrictStr] = Field(default=None, description="The status of the transfer session. A cancelled session returns the status CANCELLED.") + __properties: ClassVar[List[str]] = ["message", "transferSessionId", "dataTransferResultDetails", "status"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInPushDataCancelResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_transfer_result_details (list) + _items = [] + if self.data_transfer_result_details: + for _item_data_transfer_result_details in self.data_transfer_result_details: + if _item_data_transfer_result_details: + _items.append(_item_data_transfer_result_details.to_dict()) + _dict['dataTransferResultDetails'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInPushDataCancelResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "transferSessionId": obj.get("transferSessionId"), + "dataTransferResultDetails": [DataInDataTransferResultDetail.from_dict(_item) for _item in obj["dataTransferResultDetails"]] if obj.get("dataTransferResultDetails") is not None else None, + "status": obj.get("status") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_complete_request.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_complete_request.py new file mode 100644 index 0000000000..3287dc0e73 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_complete_request.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInPushDataCompleteRequest(BaseModel): + """ + DataInPushDataCompleteRequest + """ # noqa: E501 + transfer_session_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the transfer session.", alias="transferSessionId") + processing_data: Optional[StrictBool] = Field(default=None, description="If `true`, a processing job will be triggered after the receiving job successfully completes. This generates a new data version.", alias="processingData") + __properties: ClassVar[List[str]] = ["transferSessionId", "processingData"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInPushDataCompleteRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInPushDataCompleteRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "transferSessionId": obj.get("transferSessionId"), + "processingData": obj.get("processingData") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_complete_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_complete_response.py new file mode 100644 index 0000000000..717aa252d9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_complete_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_data_transfer_result_detail import DataInDataTransferResultDetail +from typing import Optional, Set +from typing_extensions import Self + +class DataInPushDataCompleteResponse(BaseModel): + """ + DataInPushDataCompleteResponse + """ # noqa: E501 + data_receiving_job_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the receiving job.", alias="dataReceivingJobId") + message: Optional[StrictStr] = Field(default=None, description="A meaningful message about the transfer session.") + transfer_session_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the transfer session.", alias="transferSessionId") + data_transfer_result_details: Optional[List[DataInDataTransferResultDetail]] = Field(default=None, description="A list of objects representing the results of the transfer session.", alias="dataTransferResultDetails") + status: Optional[StrictStr] = Field(default=None, description="The status of the transfer session. A completed session returns the status SUCCEED.") + __properties: ClassVar[List[str]] = ["dataReceivingJobId", "message", "transferSessionId", "dataTransferResultDetails", "status"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInPushDataCompleteResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_transfer_result_details (list) + _items = [] + if self.data_transfer_result_details: + for _item_data_transfer_result_details in self.data_transfer_result_details: + if _item_data_transfer_result_details: + _items.append(_item_data_transfer_result_details.to_dict()) + _dict['dataTransferResultDetails'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInPushDataCompleteResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataReceivingJobId": obj.get("dataReceivingJobId"), + "message": obj.get("message"), + "transferSessionId": obj.get("transferSessionId"), + "dataTransferResultDetails": [DataInDataTransferResultDetail.from_dict(_item) for _item in obj["dataTransferResultDetails"]] if obj.get("dataTransferResultDetails") is not None else None, + "status": obj.get("status") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_response.py new file mode 100644 index 0000000000..20a023777c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_push_data_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_tenant import DataInTenant +from typing import Optional, Set +from typing_extensions import Self + +class DataInPushDataResponse(BaseModel): + """ + DataInPushDataResponse + """ # noqa: E501 + transfer_session_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the transfer session.", alias="transferSessionId") + sequence: Optional[StrictInt] = Field(default=None, description="The unique sequence number associated with a batch of records.") + status: Optional[StrictStr] = Field(default=None, description="The status of the data transfer.") + message: Optional[StrictStr] = Field(default=None, description="Any additional information about the data transfer.") + tenants: Optional[List[DataInTenant]] = Field(default=None, description="A list of strings representing the tenants that data was pushed to and their data transfer results.") + __properties: ClassVar[List[str]] = ["transferSessionId", "sequence", "status", "message", "tenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInPushDataResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInPushDataResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "transferSessionId": obj.get("transferSessionId"), + "sequence": obj.get("sequence"), + "status": obj.get("status"), + "message": obj.get("message"), + "tenants": [DataInTenant.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_receiving_job.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_receiving_job.py new file mode 100644 index 0000000000..e6341189f6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_receiving_job.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInReceivingJob(BaseModel): + """ + DataInReceivingJob + """ # noqa: E501 + receiving_job_id: Optional[StrictStr] = Field(default=None, description="The job ID of the receiving job for the analytic tenant.", alias="receivingJobId") + tenant_code: Optional[StrictStr] = Field(default=None, description="The analytic tenant code.", alias="tenantCode") + status: Optional[StrictStr] = Field(default=None, description="The status of the receiving job for the analytic tenant.") + __properties: ClassVar[List[str]] = ["receivingJobId", "tenantCode", "status"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInReceivingJob from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInReceivingJob from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "receivingJobId": obj.get("receivingJobId"), + "tenantCode": obj.get("tenantCode"), + "status": obj.get("status") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_receiving_job_and_status_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_receiving_job_and_status_response.py new file mode 100644 index 0000000000..c8ddc8fdd6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_receiving_job_and_status_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_receiving_job import DataInReceivingJob +from typing import Optional, Set +from typing_extensions import Self + +class DataInReceivingJobAndStatusResponse(BaseModel): + """ + DataInReceivingJobAndStatusResponse + """ # noqa: E501 + parent_job_id: Optional[StrictStr] = Field(default=None, description="The ID of the dispatching job that generated the extraction jobs.", alias="parentJobId") + parent_tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant that owns the dispatching job. This is usually the administrating tenant.", alias="parentTenantCode") + limit: Optional[StrictInt] = Field(default=None, description="The number of receiving jobs to return. The maximum number of jobs to return is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving results from, also known as offset. The index begins at 0.") + receiving_jobs: Optional[List[DataInReceivingJob]] = Field(default=None, description="A list of receiving job information.", alias="receivingJobs") + __properties: ClassVar[List[str]] = ["parentJobId", "parentTenantCode", "limit", "start", "receivingJobs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInReceivingJobAndStatusResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in receiving_jobs (list) + _items = [] + if self.receiving_jobs: + for _item_receiving_jobs in self.receiving_jobs: + if _item_receiving_jobs: + _items.append(_item_receiving_jobs.to_dict()) + _dict['receivingJobs'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInReceivingJobAndStatusResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "parentJobId": obj.get("parentJobId"), + "parentTenantCode": obj.get("parentTenantCode"), + "limit": obj.get("limit"), + "start": obj.get("start"), + "receivingJobs": [DataInReceivingJob.from_dict(_item) for _item in obj["receivingJobs"]] if obj.get("receivingJobs") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_receiving_job_status_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_receiving_job_status_response.py new file mode 100644 index 0000000000..d3c4499dbf --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_receiving_job_status_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_receiving_job import DataInReceivingJob +from typing import Optional, Set +from typing_extensions import Self + +class DataInReceivingJobStatusResponse(BaseModel): + """ + DataInReceivingJobStatusResponse + """ # noqa: E501 + job_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the receiving job.", alias="jobId") + status: Optional[StrictStr] = Field(default=None, description="The status of the receiving job.") + parent_job_id: Optional[StrictStr] = Field(default=None, description="The job ID of the receiving job that spawned this job.", alias="parentJobId") + parent_tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the receiving job that spawned this job.", alias="parentTenantCode") + receiving_jobs: Optional[List[DataInReceivingJob]] = Field(default=None, description="A list of objects representing the receiving jobs to retrieve.", alias="receivingJobs") + __properties: ClassVar[List[str]] = ["jobId", "status", "parentJobId", "parentTenantCode", "receivingJobs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInReceivingJobStatusResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in receiving_jobs (list) + _items = [] + if self.receiving_jobs: + for _item_receiving_jobs in self.receiving_jobs: + if _item_receiving_jobs: + _items.append(_item_receiving_jobs.to_dict()) + _dict['receivingJobs'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInReceivingJobStatusResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobId": obj.get("jobId"), + "status": obj.get("status"), + "parentJobId": obj.get("parentJobId"), + "parentTenantCode": obj.get("parentTenantCode"), + "receivingJobs": [DataInReceivingJob.from_dict(_item) for _item in obj["receivingJobs"]] if obj.get("receivingJobs") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_result.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_result.py new file mode 100644 index 0000000000..e60a499e20 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_result.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInResult(BaseModel): + """ + DataInResult + """ # noqa: E501 + job_id: Optional[StrictStr] = Field(default=None, description="If applicable, the job ID associated with the data version.", alias="jobId") + data_version: Optional[StrictStr] = Field(default=None, description="If applicable, the data version that was disabled.", alias="dataVersion") + tenant_code: Optional[StrictStr] = Field(default=None, description="The analytic tenant that the disable operation was conducted for.", alias="tenantCode") + status: Optional[StrictStr] = Field(default=None, description="The outcome of the disabling operation.") + message: Optional[StrictStr] = Field(default=None, description="If applicable, the message explains what errors occurred while disabling data versions.") + __properties: ClassVar[List[str]] = ["jobId", "dataVersion", "tenantCode", "status", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobId": obj.get("jobId"), + "dataVersion": obj.get("dataVersion"), + "tenantCode": obj.get("tenantCode"), + "status": obj.get("status"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_source.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_source.py new file mode 100644 index 0000000000..544b0c3783 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_source.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInSource(BaseModel): + """ + DataInSource + """ # noqa: E501 + source_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the source that data was transferred to.", alias="sourceId") + source_name: Optional[StrictStr] = Field(default=None, description="The object name of the source.", alias="sourceName") + data_size: Optional[StrictStr] = Field(default=None, description="The size of the data transfer in bytes.", alias="dataSize") + rows: Optional[StrictStr] = Field(default=None, description="The number of rows in the data transfer.") + status: Optional[StrictStr] = Field(default=None, description="The status of the data transfer for this source.") + message: Optional[StrictStr] = Field(default=None, description="A meaningful message about the data transfer.") + __properties: ClassVar[List[str]] = ["sourceId", "sourceName", "dataSize", "rows", "status", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sourceId": obj.get("sourceId"), + "sourceName": obj.get("sourceName"), + "dataSize": obj.get("dataSize"), + "rows": obj.get("rows"), + "status": obj.get("status"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_start_extraction_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_start_extraction_response.py new file mode 100644 index 0000000000..4b6e66b401 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_start_extraction_response.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInStartExtractionResponse(BaseModel): + """ + DataInStartExtractionResponse + """ # noqa: E501 + job_id: Optional[StrictStr] = Field(default=None, description="The ID of the dispatching job that generated the extraction jobs.", alias="JobId") + __properties: ClassVar[List[str]] = ["JobId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInStartExtractionResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInStartExtractionResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "JobId": obj.get("JobId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_start_transfer_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_start_transfer_response.py new file mode 100644 index 0000000000..a91643a3d2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_start_transfer_response.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInStartTransferResponse(BaseModel): + """ + DataInStartTransferResponse + """ # noqa: E501 + transfer_session_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the transfer session.", alias="transferSessionId") + __properties: ClassVar[List[str]] = ["transferSessionId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInStartTransferResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInStartTransferResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "transferSessionId": obj.get("transferSessionId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_tenant.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_tenant.py new file mode 100644 index 0000000000..15a80a1eb7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_tenant.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.data_in_source import DataInSource +from typing import Optional, Set +from typing_extensions import Self + +class DataInTenant(BaseModel): + """ + DataInTenant + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant that data was transferred to. For example, WFF_j1r or WFF_j1r~c7o.", alias="tenantCode") + status: Optional[StrictStr] = Field(default=None, description="The status of the data transfer for this tenant.") + sources: Optional[List[DataInSource]] = Field(default=None, description="A list of objects representing the sources that data was pushed to and their data transfer results.") + __properties: ClassVar[List[str]] = ["tenantCode", "status", "sources"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInTenant from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in sources (list) + _items = [] + if self.sources: + for _item_sources in self.sources: + if _item_sources: + _items.append(_item_sources.to_dict()) + _dict['sources'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInTenant from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "status": obj.get("status"), + "sources": [DataInSource.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_tenant_and_credential.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_tenant_and_credential.py new file mode 100644 index 0000000000..76c2e2c739 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_tenant_and_credential.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInTenantAndCredential(BaseModel): + """ + DataInTenantAndCredential + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the tenant.", alias="tenantCode") + credential_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the credential.", alias="credentialId") + __properties: ClassVar[List[str]] = ["tenantCode", "credentialId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInTenantAndCredential from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInTenantAndCredential from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "credentialId": obj.get("credentialId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_upload_to_exclude.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_upload_to_exclude.py new file mode 100644 index 0000000000..12306fe8d9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_upload_to_exclude.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInUploadToExclude(BaseModel): + """ + DataInUploadToExclude + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant you are excluding a data upload for.", alias="tenantCode") + exclude_all: Optional[StrictBool] = Field(default=None, description="If `true`, all data uploads are excluded for the analytic tenant.", alias="excludeAll") + upload_times: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of ISO-8601 time strings such as `\"2001-10-25T13:45:35.999\"` representing the upload time of each data upload to exclude.", alias="uploadTimes") + min_upload_time: Optional[StrictStr] = Field(default=None, description="An ISO-8601 time such as `\"2001-10-25T13:45:35.999\"` for the earliest upload time. If defined, omit `uploadTimes`. If omitted and `maxUploadTime` is defined, excludes files up to earliest time available.", alias="minUploadTime") + max_upload_time: Optional[StrictStr] = Field(default=None, description="An ISO-8601 time such as `\"2001-10-25T13:45:35.999\"` for the latest upload time. If defined, omit `uploadTimes`. If omitted and `minUploadTime` is defined, excludes files up to latest time available.", alias="maxUploadTime") + sources: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings representing the object name of each source to exclude. If `uploadTimes` is omitted, excludes files for the given sources for all `uploadTimes`.") + __properties: ClassVar[List[str]] = ["tenantCode", "excludeAll", "uploadTimes", "minUploadTime", "maxUploadTime", "sources"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInUploadToExclude from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInUploadToExclude from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "excludeAll": obj.get("excludeAll"), + "uploadTimes": obj.get("uploadTimes"), + "minUploadTime": obj.get("minUploadTime"), + "maxUploadTime": obj.get("maxUploadTime"), + "sources": obj.get("sources") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_in_upload_to_include.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_upload_to_include.py new file mode 100644 index 0000000000..f983f31ff9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_in_upload_to_include.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataInUploadToInclude(BaseModel): + """ + DataInUploadToInclude + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant you are including a data upload for.", alias="tenantCode") + include_all: Optional[StrictBool] = Field(default=None, description="If `true`, all data uploads are included for the analytic tenant.", alias="includeAll") + upload_times: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of ISO-8601 time strings such as `\"2001-10-25T13:45:35.999\"` representing the upload time of each data upload to include.", alias="uploadTimes") + min_upload_time: Optional[StrictStr] = Field(default=None, description="An ISO-8601 time such as `\"2001-10-25T13:45:35.999\"` for the earliest upload time. If defined, omit `uploadTimes`. If omitted and `maxUploadTime` is defined, includes files up to earliest time available.", alias="minUploadTime") + max_upload_time: Optional[StrictStr] = Field(default=None, description="An ISO-8601 time such as `\"2001-10-25T13:45:35.999\"` for the latest upload time. If defined, omit `uploadTimes`. If omitted and `minUploadTime` is defined, includes files up to latest time available.", alias="maxUploadTime") + sources: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings representing the object name of each source to include. If `uploadTimes` is omitted, includes files for the given sources for all `uploadTimes`.") + __properties: ClassVar[List[str]] = ["tenantCode", "includeAll", "uploadTimes", "minUploadTime", "maxUploadTime", "sources"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataInUploadToInclude from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataInUploadToInclude from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "includeAll": obj.get("includeAll"), + "uploadTimes": obj.get("uploadTimes"), + "minUploadTime": obj.get("minUploadTime"), + "maxUploadTime": obj.get("maxUploadTime"), + "sources": obj.get("sources") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/data_out_list_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/data_out_list_response.py new file mode 100644 index 0000000000..79f907da40 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/data_out_list_response.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.google_protobuf_any import GoogleProtobufAny +from typing import Optional, Set +from typing_extensions import Self + +class DataOutListResponse(BaseModel): + """ + DataOutListResponse + """ # noqa: E501 + header: Optional[GoogleProtobufAny] = None + rows: Optional[List[GoogleProtobufAny]] = None + __properties: ClassVar[List[str]] = ["header", "rows"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataOutListResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of header + if self.header: + _dict['header'] = self.header.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in rows (list) + _items = [] + if self.rows: + for _item_rows in self.rows: + if _item_rows: + _items.append(_item_rows.to_dict()) + _dict['rows'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataOutListResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "header": GoogleProtobufAny.from_dict(obj["header"]) if obj.get("header") is not None else None, + "rows": [GoogleProtobufAny.from_dict(_item) for _item in obj["rows"]] if obj.get("rows") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_common_dimension_member_reference_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_common_dimension_member_reference_dto.py new file mode 100644 index 0000000000..ae45532cd6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_common_dimension_member_reference_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesCommonDimensionMemberReferenceDTO(BaseModel): + """ + The members of a dimension. + """ # noqa: E501 + path: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing the members within a dimension path. For example, a dimension for Location may have the paths \"Canada, BC, Vancouver\" and \"US, California, San Francisco\".") + member_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dimension member. Use `memberId` if the dimension member doesn't have a path, such as SD groups.", alias="memberId") + __properties: ClassVar[List[str]] = ["path", "memberId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesCommonDimensionMemberReferenceDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesCommonDimensionMemberReferenceDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "path": obj.get("path"), + "memberId": obj.get("memberId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_common_member_values_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_common_member_values_dto.py new file mode 100644 index 0000000000..6484767741 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_common_member_values_dto.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_common_dimension_member_reference_dto import DataservicesCommonDimensionMemberReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesCommonMemberValuesDTO(BaseModel): + """ + Member filter values are discrete member references in a dimension filter. You can define included and excluded members simultaneously. This is typically done with filtering applied on dimensions with multiple levels. For example, a Location parameter may include \"South America\" and exclude \"Brazil\" which results in the metric being evaluated for all South American countries except Brazil. + """ # noqa: E501 + included: Optional[List[DataservicesCommonDimensionMemberReferenceDTO]] = Field(default=None, description="The unique IDs of members to include when evaluating the metric.") + excluded: Optional[List[DataservicesCommonDimensionMemberReferenceDTO]] = Field(default=None, description="The unique IDs of members to exclude when evaluating the metric.") + __properties: ClassVar[List[str]] = ["included", "excluded"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesCommonMemberValuesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in included (list) + _items = [] + if self.included: + for _item_included in self.included: + if _item_included: + _items.append(_item_included.to_dict()) + _dict['included'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in excluded (list) + _items = [] + if self.excluded: + for _item_excluded in self.excluded: + if _item_excluded: + _items.append(_item_excluded.to_dict()) + _dict['excluded'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesCommonMemberValuesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "included": [DataservicesCommonDimensionMemberReferenceDTO.from_dict(_item) for _item in obj["included"]] if obj.get("included") is not None else None, + "excluded": [DataservicesCommonDimensionMemberReferenceDTO.from_dict(_item) for _item in obj["excluded"]] if obj.get("excluded") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_aggregation_type_option_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_aggregation_type_option_dto.py new file mode 100644 index 0000000000..e2025e1d16 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_aggregation_type_option_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelAggregationTypeOptionDTO(BaseModel): + """ + The definition of an aggregation option. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the parameter option.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the parameter option.", alias="displayName") + property_name: Optional[StrictStr] = Field(default=None, description="The property name of the parameter option.", alias="propertyName") + aggregation_function: Optional[StrictStr] = Field(default=None, description="The aggregation function of the parameter option.", alias="aggregationFunction") + is_default: Optional[StrictBool] = Field(default=None, description="`true` if the parameter option is the default one and `false` otherwise.", alias="isDefault") + __properties: ClassVar[List[str]] = ["id", "displayName", "propertyName", "aggregationFunction", "isDefault"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelAggregationTypeOptionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelAggregationTypeOptionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "propertyName": obj.get("propertyName"), + "aggregationFunction": obj.get("aggregationFunction"), + "isDefault": obj.get("isDefault") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_aggregation_type_parameter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_aggregation_type_parameter_dto.py new file mode 100644 index 0000000000..b24fdebddd --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_aggregation_type_parameter_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_aggregation_type_option_dto import DataservicesDatamodelAggregationTypeOptionDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelAggregationTypeParameterDTO(BaseModel): + """ + The definition of an aggregation parameter. These parameters resolve metrics that use aggregation parameters. For example, Visier Benchmarks metrics often use aggregation parameters to enable callers to aggregate metric values according to their average or different percentiles. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the parameter.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the parameter.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the parameter.") + parameter_options: Optional[List[DataservicesDatamodelAggregationTypeOptionDTO]] = Field(default=None, description="The options defined for the parameter.", alias="parameterOptions") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "parameterOptions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelAggregationTypeParameterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in parameter_options (list) + _items = [] + if self.parameter_options: + for _item_parameter_options in self.parameter_options: + if _item_parameter_options: + _items.append(_item_parameter_options.to_dict()) + _dict['parameterOptions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelAggregationTypeParameterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "parameterOptions": [DataservicesDatamodelAggregationTypeOptionDTO.from_dict(_item) for _item in obj["parameterOptions"]] if obj.get("parameterOptions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_analytic_object_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_analytic_object_dto.py new file mode 100644 index 0000000000..41473ce988 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_analytic_object_dto.py @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_object_reference_dto import DataservicesDatamodelObjectReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_population_configuration_dto import DataservicesDatamodelPopulationConfigurationDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelAnalyticObjectDTO(BaseModel): + """ + Analytic objects are the various items that users can analyze in Visier. Analytic objects include subjects, events, and overlays. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analytic object. Note: See `AnalyticObjects` to get the ID.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the analytic object.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the analytic object.") + type: Optional[StrictStr] = Field(default=None, description="The analytic object type: SUBJECT, EVENT, or OVERLAY.") + data_start_date: Optional[StrictStr] = Field(default=None, description="The date from which data becomes available for this analytic object. Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string. Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent limitation in representing large numbers.", alias="dataStartDate") + data_end_date: Optional[StrictStr] = Field(default=None, description="The date from which data is no longer available for this analytic object. Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string. Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent limitation in representing large numbers.", alias="dataEndDate") + property_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing IDs of the properties that belong to this analytic object.", alias="propertyIds") + dimension_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing IDs of the dimensions that belong to this analytic object.", alias="dimensionIds") + selection_concept_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing IDs of the selection concepts that belong to this analytic object. Note: If there are no selection concepts, this field is omitted.", alias="selectionConceptIds") + object_references: Optional[List[DataservicesDatamodelObjectReferenceDTO]] = Field(default=None, description="A list of references from this analytic object to other analytic objects. Note: If there are no references, this field is omitted.", alias="objectReferences") + population_configuration: Optional[DataservicesDatamodelPopulationConfigurationDTO] = Field(default=None, description="A set of property and dimension references configured by Visier or an administrator to tell the platform what properties and dimensions to use when doing population insight calculations. These are the distinguishing properties, change history properties, and grouping dimensions to use in AI insights. This field is optional and is only available for subjects.", alias="populationConfiguration") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "type", "dataStartDate", "dataEndDate", "propertyIds", "dimensionIds", "selectionConceptIds", "objectReferences", "populationConfiguration"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SUBJECT', 'EVENT', 'OVERLAY']): + raise ValueError("must be one of enum values ('SUBJECT', 'EVENT', 'OVERLAY')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelAnalyticObjectDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in object_references (list) + _items = [] + if self.object_references: + for _item_object_references in self.object_references: + if _item_object_references: + _items.append(_item_object_references.to_dict()) + _dict['objectReferences'] = _items + # override the default output from pydantic by calling `to_dict()` of population_configuration + if self.population_configuration: + _dict['populationConfiguration'] = self.population_configuration.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelAnalyticObjectDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "type": obj.get("type"), + "dataStartDate": obj.get("dataStartDate"), + "dataEndDate": obj.get("dataEndDate"), + "propertyIds": obj.get("propertyIds"), + "dimensionIds": obj.get("dimensionIds"), + "selectionConceptIds": obj.get("selectionConceptIds"), + "objectReferences": [DataservicesDatamodelObjectReferenceDTO.from_dict(_item) for _item in obj["objectReferences"]] if obj.get("objectReferences") is not None else None, + "populationConfiguration": DataservicesDatamodelPopulationConfigurationDTO.from_dict(obj["populationConfiguration"]) if obj.get("populationConfiguration") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_analytic_objects_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_analytic_objects_dto.py new file mode 100644 index 0000000000..9f35d49706 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_analytic_objects_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_analytic_object_dto import DataservicesDatamodelAnalyticObjectDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelAnalyticObjectsDTO(BaseModel): + """ + A collection of analytic objects + """ # noqa: E501 + analytic_objects: Optional[List[DataservicesDatamodelAnalyticObjectDTO]] = Field(default=None, alias="analyticObjects") + __properties: ClassVar[List[str]] = ["analyticObjects"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelAnalyticObjectsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in analytic_objects (list) + _items = [] + if self.analytic_objects: + for _item_analytic_objects in self.analytic_objects: + if _item_analytic_objects: + _items.append(_item_analytic_objects.to_dict()) + _dict['analyticObjects'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelAnalyticObjectsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjects": [DataservicesDatamodelAnalyticObjectDTO.from_dict(_item) for _item in obj["analyticObjects"]] if obj.get("analyticObjects") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currencies_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currencies_dto.py new file mode 100644 index 0000000000..698d518389 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currencies_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_currency_dto import DataservicesDatamodelCurrencyDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelCurrenciesDTO(BaseModel): + """ + A collection of currencies. + """ # noqa: E501 + currencies: Optional[List[DataservicesDatamodelCurrencyDTO]] = None + __properties: ClassVar[List[str]] = ["currencies"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelCurrenciesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in currencies (list) + _items = [] + if self.currencies: + for _item_currencies in self.currencies: + if _item_currencies: + _items.append(_item_currencies.to_dict()) + _dict['currencies'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelCurrenciesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "currencies": [DataservicesDatamodelCurrencyDTO.from_dict(_item) for _item in obj["currencies"]] if obj.get("currencies") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currency_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currency_dto.py new file mode 100644 index 0000000000..965067f921 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currency_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelCurrencyDTO(BaseModel): + """ + Information about a currency type. + """ # noqa: E501 + currency_code: Optional[StrictStr] = Field(default=None, description="The ISO 4217 3-letter code for the currency.", alias="currencyCode") + display_name: Optional[StrictStr] = Field(default=None, description="The display name for the currency.", alias="displayName") + symbol: Optional[StrictStr] = Field(default=None, description="The symbol name for the currency.") + short_symbol: Optional[StrictStr] = Field(default=None, description="The shortened symbol name for the currency. Removes all alphabetic characters. If **symbol** only has alphabetic characters, **shortSymbol** is empty. If **symbol** contains only non-alphabetic characters, **shortSymbol** is the same as **symbol**. For example, if **symbol** is CA$, **shortSymbol** is $. If **symbol** is $, then **shortSymbol** is $.", alias="shortSymbol") + __properties: ClassVar[List[str]] = ["currencyCode", "displayName", "symbol", "shortSymbol"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelCurrencyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelCurrencyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "currencyCode": obj.get("currencyCode"), + "displayName": obj.get("displayName"), + "symbol": obj.get("symbol"), + "shortSymbol": obj.get("shortSymbol") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currency_rate_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currency_rate_dto.py new file mode 100644 index 0000000000..918005e521 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currency_rate_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelCurrencyRateDTO(BaseModel): + """ + Information about a currency exchange rate. + """ # noqa: E501 + from_currency_code: Optional[StrictStr] = Field(default=None, description="The currency to convert **from**. **Note:** If USD is the `fromCurrencyCode`, you are retrieving the exchange rates from USD to a different currency.", alias="fromCurrencyCode") + to_currency_code: Optional[StrictStr] = Field(default=None, description="The currency to convert **to**. **Note:** If USD is the `toCurrencyCode`, you are retrieving the exchange rates from a different currency to USD.", alias="toCurrencyCode") + rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The numeric value of the exchange rate. **Note:** If **decimals** is specified, rate rounds to that value. If **decimals** is undefined, **rate** rounds to 2 significant figures after the decimal point.") + start_time: Optional[StrictStr] = Field(default=None, description="The earliest time instant to retrieve exchange rates from. **Note:** Format is the number of milliseconds since Jan 1, 1970 12:00 AM UTC.", alias="startTime") + end_time: Optional[StrictStr] = Field(default=None, description="The latest time instant to retrieve exchange rates from. **Note:** Format is the number of milliseconds since Jan 1, 1970 12:00 AM UTC.", alias="endTime") + __properties: ClassVar[List[str]] = ["fromCurrencyCode", "toCurrencyCode", "rate", "startTime", "endTime"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelCurrencyRateDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelCurrencyRateDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fromCurrencyCode": obj.get("fromCurrencyCode"), + "toCurrencyCode": obj.get("toCurrencyCode"), + "rate": obj.get("rate"), + "startTime": obj.get("startTime"), + "endTime": obj.get("endTime") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currency_rates_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currency_rates_dto.py new file mode 100644 index 0000000000..043537f0d7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_currency_rates_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_currency_rate_dto import DataservicesDatamodelCurrencyRateDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelCurrencyRatesDTO(BaseModel): + """ + A collection of currency exchange rates. Note: Currencies may have different exchange rates in different time intervals, depending what rate data is stored in Visier. For example, USD:CAD can be 1.2 between January 1 - March 1, while USD:EUR can be 0.92 between January 1 - February 1, but 0.88 between February 1 - March 1. + """ # noqa: E501 + currency_rates: Optional[List[DataservicesDatamodelCurrencyRateDTO]] = Field(default=None, alias="currencyRates") + __properties: ClassVar[List[str]] = ["currencyRates"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelCurrencyRatesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in currency_rates (list) + _items = [] + if self.currency_rates: + for _item_currency_rates in self.currency_rates: + if _item_currency_rates: + _items.append(_item_currency_rates.to_dict()) + _dict['currencyRates'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelCurrencyRatesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "currencyRates": [DataservicesDatamodelCurrencyRateDTO.from_dict(_item) for _item in obj["currencyRates"]] if obj.get("currencyRates") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_dto.py new file mode 100644 index 0000000000..328c5cabda --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_dto.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_level_dto import DataservicesDatamodelLevelDTO +from visier_platform_sdk.models.dataservices_datamodel_tag_map_element_dto import DataservicesDatamodelTagMapElementDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelDimensionDTO(BaseModel): + """ + A dimension organizes unique values of an attribute into a list or a hierarchical structure for use as a filter or group-by in your solution. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the dimension.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the dimension.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the dimension.") + levels: Optional[List[DataservicesDatamodelLevelDTO]] = Field(default=None, description="The levels defined for the dimension. Note: For parent-child dimensions, a level name is generated by Visier.") + unknown_member: Optional[List[StrictStr]] = Field(default=None, description="The optional path to the unknown member, if defined.", alias="unknownMember") + member_count: Optional[StrictInt] = Field(default=None, description="The total number of members for the dimension, excluding the (All) member.", alias="memberCount") + visible_in_app: Optional[StrictBool] = Field(default=None, description="`true` if this dimension is set to be visible in your solution.", alias="visibleInApp") + tags: Optional[List[DataservicesDatamodelTagMapElementDTO]] = Field(default=None, description="The optional collection of tags defined for this element.") + explanation: Optional[StrictStr] = Field(default=None, description="The localized explanation of the dimension.") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "levels", "unknownMember", "memberCount", "visibleInApp", "tags", "explanation"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelDimensionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in levels (list) + _items = [] + if self.levels: + for _item_levels in self.levels: + if _item_levels: + _items.append(_item_levels.to_dict()) + _dict['levels'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in tags (list) + _items = [] + if self.tags: + for _item_tags in self.tags: + if _item_tags: + _items.append(_item_tags.to_dict()) + _dict['tags'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelDimensionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "levels": [DataservicesDatamodelLevelDTO.from_dict(_item) for _item in obj["levels"]] if obj.get("levels") is not None else None, + "unknownMember": obj.get("unknownMember"), + "memberCount": obj.get("memberCount"), + "visibleInApp": obj.get("visibleInApp"), + "tags": [DataservicesDatamodelTagMapElementDTO.from_dict(_item) for _item in obj["tags"]] if obj.get("tags") is not None else None, + "explanation": obj.get("explanation") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_dto.py new file mode 100644 index 0000000000..c3cfaa6ac7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_common_dimension_member_reference_dto import DataservicesCommonDimensionMemberReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelDimensionMappingValidationDTO(BaseModel): + """ + DataservicesDatamodelDimensionMappingValidationDTO + """ # noqa: E501 + dimension_map_id: Optional[StrictStr] = Field(default=None, alias="dimensionMapId") + dimension_id: Optional[StrictStr] = Field(default=None, alias="dimensionId") + unmapped_members: Optional[List[DataservicesCommonDimensionMemberReferenceDTO]] = Field(default=None, alias="unmappedMembers") + failures: Optional[List[StrictStr]] = None + __properties: ClassVar[List[str]] = ["dimensionMapId", "dimensionId", "unmappedMembers", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelDimensionMappingValidationDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in unmapped_members (list) + _items = [] + if self.unmapped_members: + for _item_unmapped_members in self.unmapped_members: + if _item_unmapped_members: + _items.append(_item_unmapped_members.to_dict()) + _dict['unmappedMembers'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelDimensionMappingValidationDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionMapId": obj.get("dimensionMapId"), + "dimensionId": obj.get("dimensionId"), + "unmappedMembers": [DataservicesCommonDimensionMemberReferenceDTO.from_dict(_item) for _item in obj["unmappedMembers"]] if obj.get("unmappedMembers") is not None else None, + "failures": obj.get("failures") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_execution_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_execution_dto.py new file mode 100644 index 0000000000..0b36c1710a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_execution_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelDimensionMappingValidationExecutionDTO(BaseModel): + """ + Instruction to execute a mapping validation query + """ # noqa: E501 + member_map_id: Optional[StrictStr] = Field(default=None, description="memberMapId == dimensionMapId", alias="memberMapId") + analytic_object: Optional[StrictStr] = Field(default=None, description="the analytic object associated with the dimension map", alias="analyticObject") + __properties: ClassVar[List[str]] = ["memberMapId", "analyticObject"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelDimensionMappingValidationExecutionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelDimensionMappingValidationExecutionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "memberMapId": obj.get("memberMapId"), + "analyticObject": obj.get("analyticObject") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_reference_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_reference_dto.py new file mode 100644 index 0000000000..2e4e651a4f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimension_reference_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelDimensionReferenceDTO(BaseModel): + """ + The name and qualifying path of a dimension to query. + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The ID of the dimension. To get a dimension's ID, call the Data Model API.") + qualifying_path: Optional[StrictStr] = Field(default=None, description="The qualifying path to the dimension in Visier, such as the analytic object or event the dimension is associated with. If the path has multiple objects, each object is separated by a period.", alias="qualifyingPath") + __properties: ClassVar[List[str]] = ["name", "qualifyingPath"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelDimensionReferenceDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelDimensionReferenceDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "qualifyingPath": obj.get("qualifyingPath") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimensions_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimensions_dto.py new file mode 100644 index 0000000000..d3bf83e4d8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_dimensions_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_dimension_dto import DataservicesDatamodelDimensionDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelDimensionsDTO(BaseModel): + """ + A collection of dimensions. + """ # noqa: E501 + dimensions: Optional[List[DataservicesDatamodelDimensionDTO]] = None + __properties: ClassVar[List[str]] = ["dimensions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelDimensionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensions (list) + _items = [] + if self.dimensions: + for _item_dimensions in self.dimensions: + if _item_dimensions: + _items.append(_item_dimensions.to_dict()) + _dict['dimensions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelDimensionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensions": [DataservicesDatamodelDimensionDTO.from_dict(_item) for _item in obj["dimensions"]] if obj.get("dimensions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_level_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_level_dto.py new file mode 100644 index 0000000000..e8f458aac0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_level_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelLevelDTO(BaseModel): + """ + Levels are the hierarchical structure of members within a dimension. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of a level within a dimension.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the dimension.", alias="displayName") + depth: Optional[StrictInt] = Field(default=None, description="The level depth of the dimension.") + __properties: ClassVar[List[str]] = ["id", "displayName", "depth"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelLevelDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelLevelDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "depth": obj.get("depth") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_member_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_member_dto.py new file mode 100644 index 0000000000..202ed8e815 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_member_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_validity_range_dto import DataservicesDatamodelValidityRangeDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelMemberDTO(BaseModel): + """ + A member is an element of a dimension. Dimension members are organized hierarchically. For example, Argentina is a member of the Location dimension at the Country level of the hierarchy Region > Country > Province > City. + """ # noqa: E501 + full_name: Optional[StrictStr] = Field(default=None, description="The fully qualified name of the member. This is the dimension's object name and the member's display name, separated by a period.", alias="fullName") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the member.", alias="displayName") + level: Optional[StrictInt] = Field(default=None, description="The numeric level of the hierarchy the member belongs to.") + path: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of identifiers that reference members on the query axis as part of dimensionMemberSelection.") + validity_ranges: Optional[List[DataservicesDatamodelValidityRangeDTO]] = Field(default=None, description="The validity ranges that exist for this member.", alias="validityRanges") + display_name_path: Optional[List[StrictStr]] = Field(default=None, description="The display names for each level in the member's ancestral path.", alias="displayNamePath") + __properties: ClassVar[List[str]] = ["fullName", "displayName", "level", "path", "validityRanges", "displayNamePath"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelMemberDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in validity_ranges (list) + _items = [] + if self.validity_ranges: + for _item_validity_ranges in self.validity_ranges: + if _item_validity_ranges: + _items.append(_item_validity_ranges.to_dict()) + _dict['validityRanges'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelMemberDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fullName": obj.get("fullName"), + "displayName": obj.get("displayName"), + "level": obj.get("level"), + "path": obj.get("path"), + "validityRanges": [DataservicesDatamodelValidityRangeDTO.from_dict(_item) for _item in obj["validityRanges"]] if obj.get("validityRanges") is not None else None, + "displayNamePath": obj.get("displayNamePath") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_member_parameter_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_member_parameter_definition_dto.py new file mode 100644 index 0000000000..27633aacdb --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_member_parameter_definition_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_common_member_values_dto import DataservicesCommonMemberValuesDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelMemberParameterDefinitionDTO(BaseModel): + """ + The definition of a filter parameter. These elements are returned as part of the definition for metrics that include parameters in their definition. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the member parameter.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the member parameter.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the member parameter.") + dimension_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the dimension on which the member parameter is based.", alias="dimensionId") + reference_path: Optional[List[StrictStr]] = Field(default=None, description="The analytic object reference path from the metric to the dimension.", alias="referencePath") + default: Optional[DataservicesCommonMemberValuesDTO] = Field(default=None, description="The default value if the end user does not select a member at run time.") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "dimensionId", "referencePath", "default"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelMemberParameterDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of default + if self.default: + _dict['default'] = self.default.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelMemberParameterDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "dimensionId": obj.get("dimensionId"), + "referencePath": obj.get("referencePath"), + "default": DataservicesCommonMemberValuesDTO.from_dict(obj["default"]) if obj.get("default") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_members_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_members_dto.py new file mode 100644 index 0000000000..d4304b5d24 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_members_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_member_dto import DataservicesDatamodelMemberDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelMembersDTO(BaseModel): + """ + A collection of members. + """ # noqa: E501 + members: Optional[List[DataservicesDatamodelMemberDTO]] = None + __properties: ClassVar[List[str]] = ["members"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelMembersDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in members (list) + _items = [] + if self.members: + for _item_members in self.members: + if _item_members: + _items.append(_item_members.to_dict()) + _dict['members'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelMembersDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "members": [DataservicesDatamodelMemberDTO.from_dict(_item) for _item in obj["members"]] if obj.get("members") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_metric_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_metric_dto.py new file mode 100644 index 0000000000..90da9c899f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_metric_dto.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_parameter_definition_dto import DataservicesDatamodelParameterDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelMetricDTO(BaseModel): + """ + A metric is a calculation based on one or more attribute values of analytic objects. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the metric. Note: See `Metrics` to get the ID.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the metric.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the metric.") + data_start_date: Optional[StrictStr] = Field(default=None, description="The date from which data becomes available for this metric. Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string. Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent limitation in representing large numbers.", alias="dataStartDate") + data_end_date: Optional[StrictStr] = Field(default=None, description="The date from which data is no longer available for this metric. Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string. Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent limitation in representing large numbers.", alias="dataEndDate") + analytic_object_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analytic object.", alias="analyticObjectId") + parameters: Optional[List[DataservicesDatamodelParameterDefinitionDTO]] = Field(default=None, description="The collection of parameters defined for the metric.") + category: Optional[StrictStr] = Field(default=None, description="The category of the metric. Will be one of: `REGULAR`, `DERIVED` or `PLANNING`.") + visible_in_app: Optional[StrictBool] = Field(default=None, description="// `true` if this metric is set to be visible in your solution.", alias="visibleInApp") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "dataStartDate", "dataEndDate", "analyticObjectId", "parameters", "category", "visibleInApp"] + + @field_validator('category') + def category_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['REGULAR', 'DERIVED', 'PLANNING']): + raise ValueError("must be one of enum values ('REGULAR', 'DERIVED', 'PLANNING')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelMetricDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in parameters (list) + _items = [] + if self.parameters: + for _item_parameters in self.parameters: + if _item_parameters: + _items.append(_item_parameters.to_dict()) + _dict['parameters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelMetricDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "dataStartDate": obj.get("dataStartDate"), + "dataEndDate": obj.get("dataEndDate"), + "analyticObjectId": obj.get("analyticObjectId"), + "parameters": [DataservicesDatamodelParameterDefinitionDTO.from_dict(_item) for _item in obj["parameters"]] if obj.get("parameters") is not None else None, + "category": obj.get("category"), + "visibleInApp": obj.get("visibleInApp") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_metrics_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_metrics_dto.py new file mode 100644 index 0000000000..ea7521d62f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_metrics_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_metric_dto import DataservicesDatamodelMetricDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelMetricsDTO(BaseModel): + """ + A collection of metrics. + """ # noqa: E501 + metrics: Optional[List[DataservicesDatamodelMetricDTO]] = None + __properties: ClassVar[List[str]] = ["metrics"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelMetricsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in metrics (list) + _items = [] + if self.metrics: + for _item_metrics in self.metrics: + if _item_metrics: + _items.append(_item_metrics.to_dict()) + _dict['metrics'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelMetricsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "metrics": [DataservicesDatamodelMetricDTO.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_numeric_parameter_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_numeric_parameter_definition_dto.py new file mode 100644 index 0000000000..93ee787d1f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_numeric_parameter_definition_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelNumericParameterDefinitionDTO(BaseModel): + """ + The definition of a numeric parameter. These elements are returned as part of the query definition for metric parameter values. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the numeric parameter.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the numeric parameter.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the numeric parameter.") + lower_bound: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The lowest value for the numeric parameter.", alias="lowerBound") + upper_bound: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The highest value for the numeric parameter.", alias="upperBound") + default: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The default value if the end user does not select a member at run time.") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "lowerBound", "upperBound", "default"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelNumericParameterDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelNumericParameterDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "lowerBound": obj.get("lowerBound"), + "upperBound": obj.get("upperBound"), + "default": obj.get("default") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_object_reference_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_object_reference_dto.py new file mode 100644 index 0000000000..8106e740fb --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_object_reference_dto.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelObjectReferenceDTO(BaseModel): + """ + A link between one analytic object and another. An ObjectReference allows you to discover the relationships between analytic objects. In some queries, you may need to provide a qualifyingPath, which is built from ObjectReference information. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the object reference.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the object reference.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the object reference.") + from_object: Optional[StrictStr] = Field(default=None, description="The ID of the referencing analytic object.", alias="fromObject") + to_object: Optional[StrictStr] = Field(default=None, description="The ID of the referenced analytic object.", alias="toObject") + type: Optional[StrictStr] = Field(default=None, description="The type of object reference.") + is_strong_reference: Optional[StrictBool] = Field(default=None, description="True if this is a strong reference.", alias="isStrongReference") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "fromObject", "toObject", "type", "isStrongReference"] + + @field_validator('type') + def type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SUBJECT_REFERENCE', 'MULTI_VALUE_REFERENCE']): + raise ValueError("must be one of enum values ('SUBJECT_REFERENCE', 'MULTI_VALUE_REFERENCE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelObjectReferenceDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelObjectReferenceDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "fromObject": obj.get("fromObject"), + "toObject": obj.get("toObject"), + "type": obj.get("type"), + "isStrongReference": obj.get("isStrongReference") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_parameter_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_parameter_definition_dto.py new file mode 100644 index 0000000000..a9b222b586 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_parameter_definition_dto.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_aggregation_type_parameter_dto import DataservicesDatamodelAggregationTypeParameterDTO +from visier_platform_sdk.models.dataservices_datamodel_member_parameter_definition_dto import DataservicesDatamodelMemberParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_numeric_parameter_definition_dto import DataservicesDatamodelNumericParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_plan_parameter_definition_dto import DataservicesDatamodelPlanParameterDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelParameterDefinitionDTO(BaseModel): + """ + Parameters generalize object definitions so that end users can provide values at query run time. + """ # noqa: E501 + member_parameter: Optional[DataservicesDatamodelMemberParameterDefinitionDTO] = Field(default=None, description="A filter parameter that can be set with dimension members for the end user to select.", alias="memberParameter") + numeric_parameter: Optional[DataservicesDatamodelNumericParameterDefinitionDTO] = Field(default=None, description="A parameter with a numeric data type. A numeric parameter can be set with an optional default value and value range.", alias="numericParameter") + plan_parameter: Optional[DataservicesDatamodelPlanParameterDefinitionDTO] = Field(default=None, description="A parameter on a planning metric. Plan parameters resolve planning model metrics to a specific plan and scenario or snapshot.", alias="planParameter") + aggregation_type_parameter: Optional[DataservicesDatamodelAggregationTypeParameterDTO] = Field(default=None, description="An aggregation parameter. Such parameters enable control over how applicable metrics aggregate their results.", alias="aggregationTypeParameter") + __properties: ClassVar[List[str]] = ["memberParameter", "numericParameter", "planParameter", "aggregationTypeParameter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelParameterDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of member_parameter + if self.member_parameter: + _dict['memberParameter'] = self.member_parameter.to_dict() + # override the default output from pydantic by calling `to_dict()` of numeric_parameter + if self.numeric_parameter: + _dict['numericParameter'] = self.numeric_parameter.to_dict() + # override the default output from pydantic by calling `to_dict()` of plan_parameter + if self.plan_parameter: + _dict['planParameter'] = self.plan_parameter.to_dict() + # override the default output from pydantic by calling `to_dict()` of aggregation_type_parameter + if self.aggregation_type_parameter: + _dict['aggregationTypeParameter'] = self.aggregation_type_parameter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelParameterDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "memberParameter": DataservicesDatamodelMemberParameterDefinitionDTO.from_dict(obj["memberParameter"]) if obj.get("memberParameter") is not None else None, + "numericParameter": DataservicesDatamodelNumericParameterDefinitionDTO.from_dict(obj["numericParameter"]) if obj.get("numericParameter") is not None else None, + "planParameter": DataservicesDatamodelPlanParameterDefinitionDTO.from_dict(obj["planParameter"]) if obj.get("planParameter") is not None else None, + "aggregationTypeParameter": DataservicesDatamodelAggregationTypeParameterDTO.from_dict(obj["aggregationTypeParameter"]) if obj.get("aggregationTypeParameter") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_plan_parameter_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_plan_parameter_definition_dto.py new file mode 100644 index 0000000000..686ab66c30 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_plan_parameter_definition_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPlanParameterDefinitionDTO(BaseModel): + """ + The definition of a plan parameter. These parameters resolve planning model metrics to a specific plan and scenario or snapshot values at query runtime. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the parameter.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the parameter.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the parameter.") + model_name: Optional[StrictStr] = Field(default=None, description="The name of the planning model to which the parameter applies.", alias="modelName") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "modelName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanParameterDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanParameterDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "modelName": obj.get("modelName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_concept_filter_context_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_concept_filter_context_dto.py new file mode 100644 index 0000000000..0b6e7b054f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_concept_filter_context_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPlanningConceptFilterContextDTO(BaseModel): + """ + A plan context defined using a selection concept. + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The object name of the selection concept.") + __properties: ClassVar[List[str]] = ["name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningConceptFilterContextDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningConceptFilterContextDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_hierarchy_filter_context_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_hierarchy_filter_context_dto.py new file mode 100644 index 0000000000..1a6ef7a858 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_hierarchy_filter_context_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPlanningHierarchyFilterContextDTO(BaseModel): + """ + A plan context defined using hierarchy members + """ # noqa: E501 + hierarchy_name: Optional[StrictStr] = Field(default=None, description="The object name of the hierarchy.", alias="hierarchyName") + included_members: Optional[List[StrictStr]] = Field(default=None, description="The unique IDs of the included dimension members.", alias="includedMembers") + excluded_members: Optional[List[StrictStr]] = Field(default=None, description="The unique IDs of excluded dimension members.", alias="excludedMembers") + __properties: ClassVar[List[str]] = ["hierarchyName", "includedMembers", "excludedMembers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningHierarchyFilterContextDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningHierarchyFilterContextDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hierarchyName": obj.get("hierarchyName"), + "includedMembers": obj.get("includedMembers"), + "excludedMembers": obj.get("excludedMembers") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_model_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_model_dto.py new file mode 100644 index 0000000000..4ab8f836ff --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_model_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPlanningModelDTO(BaseModel): + """ + The basic information about the planning model. A planning model captures the planning intent, plan items, and the relationship between them. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the planning model. Note: See `PlanningModels` to get the ID.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the planning model.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the planning model.") + __properties: ClassVar[List[str]] = ["id", "displayName", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningModelDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningModelDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_models_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_models_dto.py new file mode 100644 index 0000000000..3a84fd8864 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_models_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_planning_model_dto import DataservicesDatamodelPlanningModelDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPlanningModelsDTO(BaseModel): + """ + A collection of planning modules. + """ # noqa: E501 + models: Optional[List[DataservicesDatamodelPlanningModelDTO]] = None + __properties: ClassVar[List[str]] = ["models"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningModelsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in models (list) + _items = [] + if self.models: + for _item_models in self.models: + if _item_models: + _items.append(_item_models.to_dict()) + _dict['models'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningModelsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "models": [DataservicesDatamodelPlanningModelDTO.from_dict(_item) for _item in obj["models"]] if obj.get("models") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_plan_context_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_plan_context_dto.py new file mode 100644 index 0000000000..ce6b82de1e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_plan_context_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_planning_concept_filter_context_dto import DataservicesDatamodelPlanningConceptFilterContextDTO +from visier_platform_sdk.models.dataservices_datamodel_planning_hierarchy_filter_context_dto import DataservicesDatamodelPlanningHierarchyFilterContextDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPlanningPlanContextDTO(BaseModel): + """ + The filter context for a plan. Plan contexts are defined using a set of hierarchy members or a concept. + """ # noqa: E501 + hierarchy_filter_context: Optional[DataservicesDatamodelPlanningHierarchyFilterContextDTO] = Field(default=None, description="A plan context defined using hierarchy members.", alias="hierarchyFilterContext") + concept_filter_context: Optional[DataservicesDatamodelPlanningConceptFilterContextDTO] = Field(default=None, description="A plan context defined using a selection concept.", alias="conceptFilterContext") + __properties: ClassVar[List[str]] = ["hierarchyFilterContext", "conceptFilterContext"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningPlanContextDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of hierarchy_filter_context + if self.hierarchy_filter_context: + _dict['hierarchyFilterContext'] = self.hierarchy_filter_context.to_dict() + # override the default output from pydantic by calling `to_dict()` of concept_filter_context + if self.concept_filter_context: + _dict['conceptFilterContext'] = self.concept_filter_context.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningPlanContextDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hierarchyFilterContext": DataservicesDatamodelPlanningHierarchyFilterContextDTO.from_dict(obj["hierarchyFilterContext"]) if obj.get("hierarchyFilterContext") is not None else None, + "conceptFilterContext": DataservicesDatamodelPlanningConceptFilterContextDTO.from_dict(obj["conceptFilterContext"]) if obj.get("conceptFilterContext") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_plan_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_plan_dto.py new file mode 100644 index 0000000000..0c26367043 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_plan_dto.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_planning_plan_context_dto import DataservicesDatamodelPlanningPlanContextDTO +from visier_platform_sdk.models.dataservices_datamodel_scenario_or_snapshot_dto import DataservicesDatamodelScenarioOrSnapshotDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPlanningPlanDTO(BaseModel): + """ + The definition of a plan. Plans are defined on planning models, and each plan may define multiple scenarios or snapshots. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the plan. Note: See `PlanningPlans` to get the ID.") + name: Optional[StrictStr] = Field(default=None, description="The name of the plan.") + subject_id: Optional[StrictStr] = Field(default=None, description="The ID of subject for the plan.", alias="subjectId") + default_contexts: Optional[List[DataservicesDatamodelPlanningPlanContextDTO]] = Field(default=None, description="The contexts defined for the plan.", alias="defaultContexts") + plan_dimension_ids: Optional[List[StrictStr]] = Field(default=None, description="The IDs of the dimensions defined for the plan.", alias="planDimensionIds") + scenarios: Optional[List[DataservicesDatamodelScenarioOrSnapshotDTO]] = Field(default=None, description="The available scenarios for the plan.") + snapshots: Optional[List[DataservicesDatamodelScenarioOrSnapshotDTO]] = Field(default=None, description="The available snapshots for the plan.") + __properties: ClassVar[List[str]] = ["id", "name", "subjectId", "defaultContexts", "planDimensionIds", "scenarios", "snapshots"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningPlanDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in default_contexts (list) + _items = [] + if self.default_contexts: + for _item_default_contexts in self.default_contexts: + if _item_default_contexts: + _items.append(_item_default_contexts.to_dict()) + _dict['defaultContexts'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in scenarios (list) + _items = [] + if self.scenarios: + for _item_scenarios in self.scenarios: + if _item_scenarios: + _items.append(_item_scenarios.to_dict()) + _dict['scenarios'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in snapshots (list) + _items = [] + if self.snapshots: + for _item_snapshots in self.snapshots: + if _item_snapshots: + _items.append(_item_snapshots.to_dict()) + _dict['snapshots'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningPlanDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "subjectId": obj.get("subjectId"), + "defaultContexts": [DataservicesDatamodelPlanningPlanContextDTO.from_dict(_item) for _item in obj["defaultContexts"]] if obj.get("defaultContexts") is not None else None, + "planDimensionIds": obj.get("planDimensionIds"), + "scenarios": [DataservicesDatamodelScenarioOrSnapshotDTO.from_dict(_item) for _item in obj["scenarios"]] if obj.get("scenarios") is not None else None, + "snapshots": [DataservicesDatamodelScenarioOrSnapshotDTO.from_dict(_item) for _item in obj["snapshots"]] if obj.get("snapshots") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_plans_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_plans_dto.py new file mode 100644 index 0000000000..aabf5aee86 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_planning_plans_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_planning_plan_dto import DataservicesDatamodelPlanningPlanDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPlanningPlansDTO(BaseModel): + """ + A collection of plan definitions. + """ # noqa: E501 + plans: Optional[List[DataservicesDatamodelPlanningPlanDTO]] = None + __properties: ClassVar[List[str]] = ["plans"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningPlansDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in plans (list) + _items = [] + if self.plans: + for _item_plans in self.plans: + if _item_plans: + _items.append(_item_plans.to_dict()) + _dict['plans'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPlanningPlansDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "plans": [DataservicesDatamodelPlanningPlanDTO.from_dict(_item) for _item in obj["plans"]] if obj.get("plans") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_population_configuration_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_population_configuration_dto.py new file mode 100644 index 0000000000..e122647885 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_population_configuration_dto.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_property_reference_dto import DataservicesDatamodelPropertyReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPopulationConfigurationDTO(BaseModel): + """ + A set of property and dimension references configured by Visier or an administrator to tell the platform what properties and dimensions to use when doing population insight calculations. These are the distinguishing properties, change history properties, and grouping dimensions to use in AI insights. + """ # noqa: E501 + distinguishing_properties: Optional[List[DataservicesDatamodelPropertyReferenceDTO]] = Field(default=None, description="Properties that are used by default to compare subject members.", alias="distinguishingProperties") + change_history_properties: Optional[List[DataservicesDatamodelPropertyReferenceDTO]] = Field(default=None, description="Properties that are used by default to compare subject members over time.", alias="changeHistoryProperties") + grouping_dimensions: Optional[List[DataservicesDatamodelDimensionReferenceDTO]] = Field(default=None, description="Dimensions to use for grouping and clustering the population.", alias="groupingDimensions") + __properties: ClassVar[List[str]] = ["distinguishingProperties", "changeHistoryProperties", "groupingDimensions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPopulationConfigurationDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in distinguishing_properties (list) + _items = [] + if self.distinguishing_properties: + for _item_distinguishing_properties in self.distinguishing_properties: + if _item_distinguishing_properties: + _items.append(_item_distinguishing_properties.to_dict()) + _dict['distinguishingProperties'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in change_history_properties (list) + _items = [] + if self.change_history_properties: + for _item_change_history_properties in self.change_history_properties: + if _item_change_history_properties: + _items.append(_item_change_history_properties.to_dict()) + _dict['changeHistoryProperties'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in grouping_dimensions (list) + _items = [] + if self.grouping_dimensions: + for _item_grouping_dimensions in self.grouping_dimensions: + if _item_grouping_dimensions: + _items.append(_item_grouping_dimensions.to_dict()) + _dict['groupingDimensions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPopulationConfigurationDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "distinguishingProperties": [DataservicesDatamodelPropertyReferenceDTO.from_dict(_item) for _item in obj["distinguishingProperties"]] if obj.get("distinguishingProperties") is not None else None, + "changeHistoryProperties": [DataservicesDatamodelPropertyReferenceDTO.from_dict(_item) for _item in obj["changeHistoryProperties"]] if obj.get("changeHistoryProperties") is not None else None, + "groupingDimensions": [DataservicesDatamodelDimensionReferenceDTO.from_dict(_item) for _item in obj["groupingDimensions"]] if obj.get("groupingDimensions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_prediction_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_prediction_dto.py new file mode 100644 index 0000000000..0ed3cd9f6e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_prediction_dto.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPredictionDTO(BaseModel): + """ + A prediction is a forecast of future events with advanced machine learning models. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the prediction. Note: See `Predictions` to get the ID.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the prediction.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the prediction.") + subject: Optional[StrictStr] = Field(default=None, description="The object name of the subject that the prediction applies to. For example, Employee.") + subject_key: Optional[StrictStr] = Field(default=None, description="The unique ID of the subject's property that the prediction applies to. For example, Employee.EmployeeID.", alias="subjectKey") + subject_parent_key: Optional[StrictStr] = Field(default=None, description="The unique ID of the reference that connects a subject member to other members. For example, Employee.Direct_Manager. Note: The `subjectParentKey` defines parent, child, and peer relationships between subject members.", alias="subjectParentKey") + subject_filter: Optional[StrictStr] = Field(default=None, description="The object name of a selection concept to filter the subject population. Filtering the population selects specific subject members in the prediction's training data. For example, using the isHighPerformer concept will filter the prediction to only high performing employees.", alias="subjectFilter") + event: Optional[StrictStr] = Field(default=None, description="The object name of the event to predict. The prediction's training data uses past occurrences of the event to make predictions. For example, the Predicted Risk of Resignation model uses the Employee_Exit event to estimate likelihood of exit from the organization.") + event_filter: Optional[StrictStr] = Field(default=None, description="The object name of a selection concept to filter event occurrences in the prediction's training data.", alias="eventFilter") + label_property: Optional[StrictStr] = Field(default=None, description="The unique ID of the property label for the prediction. This is automatically generated.", alias="labelProperty") + factor_properties: Optional[List[StrictStr]] = Field(default=None, description="The list of unique IDs of the properties used as prediction factors. Note: Factors are conditions used as part of a Visier prediction. For example, Compensation might be a factor in predicting an individual's risk of resignation. Factors are chosen based on: - Availability in tenants. - Prediction impact, such as salary. - Reducing bias.", alias="factorProperties") + factor_dimensions: Optional[List[StrictStr]] = Field(default=None, description="The list of unique IDs of the dimensions used as prediction factors.", alias="factorDimensions") + factor_concepts: Optional[List[StrictStr]] = Field(default=None, description="The list of unique IDs of the concepts used as prediction factors.", alias="factorConcepts") + data_start_date: Optional[StrictStr] = Field(default=None, description="The date from which data becomes available for this prediction. Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string. Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent limitation in representing large numbers.", alias="dataStartDate") + data_end_date: Optional[StrictStr] = Field(default=None, description="The date from which data is no longer available for this prediction. Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string. Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent limitation in representing large numbers.", alias="dataEndDate") + score_name: Optional[StrictStr] = Field(default=None, description="The unique name of the score property. The prediction's formula references the score property as an object. This is automatically generated.", alias="scoreName") + factors_name: Optional[StrictStr] = Field(default=None, description="The unique name of the factor property. The prediction's formula references the factor property as an object. This is automatically generated.", alias="factorsName") + minimum_training_months: Optional[StrictStr] = Field(default=None, description="The minimum amount of time, in months, to train the prediction model.", alias="minimumTrainingMonths") + is_multi_tenant: Optional[StrictBool] = Field(default=None, description="If `true`, this prediction applies to more than one tenant. If \"false\", the prediction only applies to the current tenant.", alias="isMultiTenant") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "subject", "subjectKey", "subjectParentKey", "subjectFilter", "event", "eventFilter", "labelProperty", "factorProperties", "factorDimensions", "factorConcepts", "dataStartDate", "dataEndDate", "scoreName", "factorsName", "minimumTrainingMonths", "isMultiTenant"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPredictionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPredictionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "subject": obj.get("subject"), + "subjectKey": obj.get("subjectKey"), + "subjectParentKey": obj.get("subjectParentKey"), + "subjectFilter": obj.get("subjectFilter"), + "event": obj.get("event"), + "eventFilter": obj.get("eventFilter"), + "labelProperty": obj.get("labelProperty"), + "factorProperties": obj.get("factorProperties"), + "factorDimensions": obj.get("factorDimensions"), + "factorConcepts": obj.get("factorConcepts"), + "dataStartDate": obj.get("dataStartDate"), + "dataEndDate": obj.get("dataEndDate"), + "scoreName": obj.get("scoreName"), + "factorsName": obj.get("factorsName"), + "minimumTrainingMonths": obj.get("minimumTrainingMonths"), + "isMultiTenant": obj.get("isMultiTenant") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_predictions_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_predictions_dto.py new file mode 100644 index 0000000000..387bd1baf9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_predictions_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_prediction_dto import DataservicesDatamodelPredictionDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPredictionsDTO(BaseModel): + """ + A collection of predictions. + """ # noqa: E501 + predictions: Optional[List[DataservicesDatamodelPredictionDTO]] = None + __properties: ClassVar[List[str]] = ["predictions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPredictionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in predictions (list) + _items = [] + if self.predictions: + for _item_predictions in self.predictions: + if _item_predictions: + _items.append(_item_predictions.to_dict()) + _dict['predictions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPredictionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "predictions": [DataservicesDatamodelPredictionDTO.from_dict(_item) for _item in obj["predictions"]] if obj.get("predictions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_properties_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_properties_dto.py new file mode 100644 index 0000000000..06f705ccc2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_properties_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_property_dto import DataservicesDatamodelPropertyDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPropertiesDTO(BaseModel): + """ + A collection of properties. + """ # noqa: E501 + properties: Optional[List[DataservicesDatamodelPropertyDTO]] = None + __properties: ClassVar[List[str]] = ["properties"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPropertiesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in properties (list) + _items = [] + if self.properties: + for _item_properties in self.properties: + if _item_properties: + _items.append(_item_properties.to_dict()) + _dict['properties'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPropertiesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "properties": [DataservicesDatamodelPropertyDTO.from_dict(_item) for _item in obj["properties"]] if obj.get("properties") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_property_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_property_dto.py new file mode 100644 index 0000000000..2c715d145d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_property_dto.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_parameter_definition_dto import DataservicesDatamodelParameterDefinitionDTO +from visier_platform_sdk.models.dataservices_datamodel_tag_map_element_dto import DataservicesDatamodelTagMapElementDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPropertyDTO(BaseModel): + """ + Properties are qualities of an analytic object. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the property. **Note:** See `Properties` to get the ID.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the property.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the property.") + data_type: Optional[StrictStr] = Field(default=None, description="The data type of the property, such as Categorical, HourDuration, or Ratio.", alias="dataType") + primitive_data_type: Optional[StrictStr] = Field(default=None, description="The primitive data type of the property, such as Number, String, or Boolean.", alias="primitiveDataType") + parameters: Optional[List[DataservicesDatamodelParameterDefinitionDTO]] = Field(default=None, description="The collection of parameters defined for the property.") + tags: Optional[List[DataservicesDatamodelTagMapElementDTO]] = Field(default=None, description="The optional collection of tags defined for this element.") + explanation: Optional[StrictStr] = Field(default=None, description="The localized explanation of the property.") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "dataType", "primitiveDataType", "parameters", "tags", "explanation"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPropertyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in parameters (list) + _items = [] + if self.parameters: + for _item_parameters in self.parameters: + if _item_parameters: + _items.append(_item_parameters.to_dict()) + _dict['parameters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in tags (list) + _items = [] + if self.tags: + for _item_tags in self.tags: + if _item_tags: + _items.append(_item_tags.to_dict()) + _dict['tags'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPropertyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "dataType": obj.get("dataType"), + "primitiveDataType": obj.get("primitiveDataType"), + "parameters": [DataservicesDatamodelParameterDefinitionDTO.from_dict(_item) for _item in obj["parameters"]] if obj.get("parameters") is not None else None, + "tags": [DataservicesDatamodelTagMapElementDTO.from_dict(_item) for _item in obj["tags"]] if obj.get("tags") is not None else None, + "explanation": obj.get("explanation") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_property_reference_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_property_reference_dto.py new file mode 100644 index 0000000000..d1722d5e37 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_property_reference_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelPropertyReferenceDTO(BaseModel): + """ + The name and qualifying path of a property to query. + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The ID of the property. See `Properties` to get the ID.") + qualifying_path: Optional[StrictStr] = Field(default=None, description="The qualifying path to the property in Visier, such as the analytic object or event the property is associated with. If the path has multiple objects, each object is separated by a period.", alias="qualifyingPath") + __properties: ClassVar[List[str]] = ["name", "qualifyingPath"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPropertyReferenceDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelPropertyReferenceDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "qualifyingPath": obj.get("qualifyingPath") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_scenario_or_snapshot_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_scenario_or_snapshot_dto.py new file mode 100644 index 0000000000..960f2ab00c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_scenario_or_snapshot_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelScenarioOrSnapshotDTO(BaseModel): + """ + The unique identifier and display name for plan scenarios and snapshots. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The identifier of the scenario or snapshot.") + display_name: Optional[StrictStr] = Field(default=None, description="The scenario or snapshot display name.", alias="displayName") + __properties: ClassVar[List[str]] = ["id", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelScenarioOrSnapshotDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelScenarioOrSnapshotDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_selection_concept_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_selection_concept_dto.py new file mode 100644 index 0000000000..f5de3da1f9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_selection_concept_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_tag_map_element_dto import DataservicesDatamodelTagMapElementDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelSelectionConceptDTO(BaseModel): + """ + Selection concepts select a population of subject members of a given subject or event. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the selection concept Note: See `SelectionConcepts` to get the ID.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the selection concept.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The localized description of the selection concept.") + visible_in_app: Optional[StrictBool] = Field(default=None, description="`true` if this selection concept is set to be visible in your solution.", alias="visibleInApp") + tags: Optional[List[DataservicesDatamodelTagMapElementDTO]] = Field(default=None, description="The optional collection of tags defined for this element.") + explanation: Optional[StrictStr] = Field(default=None, description="The localized explanation of the selection concept.") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "visibleInApp", "tags", "explanation"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelSelectionConceptDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tags (list) + _items = [] + if self.tags: + for _item_tags in self.tags: + if _item_tags: + _items.append(_item_tags.to_dict()) + _dict['tags'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelSelectionConceptDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "visibleInApp": obj.get("visibleInApp"), + "tags": [DataservicesDatamodelTagMapElementDTO.from_dict(_item) for _item in obj["tags"]] if obj.get("tags") is not None else None, + "explanation": obj.get("explanation") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_selection_concept_reference_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_selection_concept_reference_dto.py new file mode 100644 index 0000000000..ce0d24762d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_selection_concept_reference_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelSelectionConceptReferenceDTO(BaseModel): + """ + The name and qualifying path of a selection concept to query. + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The ID of the selection concept. See `SelectionConcepts` to get the ID.") + qualifying_path: Optional[StrictStr] = Field(default=None, description="The qualifying path to the selection concept in Visier, such as the analytic object or event the selection concept is associated with. If the path has multiple objects, each object is separated by a period.", alias="qualifyingPath") + __properties: ClassVar[List[str]] = ["name", "qualifyingPath"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelSelectionConceptReferenceDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelSelectionConceptReferenceDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "qualifyingPath": obj.get("qualifyingPath") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_selection_concepts_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_selection_concepts_dto.py new file mode 100644 index 0000000000..5e73c8fd54 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_selection_concepts_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_dto import DataservicesDatamodelSelectionConceptDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelSelectionConceptsDTO(BaseModel): + """ + A collection of selection concepts + """ # noqa: E501 + selection_concepts: Optional[List[DataservicesDatamodelSelectionConceptDTO]] = Field(default=None, alias="selectionConcepts") + __properties: ClassVar[List[str]] = ["selectionConcepts"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelSelectionConceptsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in selection_concepts (list) + _items = [] + if self.selection_concepts: + for _item_selection_concepts in self.selection_concepts: + if _item_selection_concepts: + _items.append(_item_selection_concepts.to_dict()) + _dict['selectionConcepts'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelSelectionConceptsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "selectionConcepts": [DataservicesDatamodelSelectionConceptDTO.from_dict(_item) for _item in obj["selectionConcepts"]] if obj.get("selectionConcepts") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_tag_map_element_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_tag_map_element_dto.py new file mode 100644 index 0000000000..a6dc818613 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_tag_map_element_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelTagMapElementDTO(BaseModel): + """ + Tag identifier and display name pair. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the tag.") + display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the tag.", alias="displayName") + __properties: ClassVar[List[str]] = ["id", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelTagMapElementDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelTagMapElementDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_validity_range_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_validity_range_dto.py new file mode 100644 index 0000000000..b1aa6c20ba --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_datamodel_validity_range_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesDatamodelValidityRangeDTO(BaseModel): + """ + A pair of values that represent the time interval to which the data is valid. The validity range is defined in Unix epoch format and UTC timezone. Note: Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent limitation in representing large numbers. + """ # noqa: E501 + start: Optional[StrictStr] = Field(default=None, description="The date from which data becomes available. Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.") + end: Optional[StrictStr] = Field(default=None, description="The date from which data is no longer available. Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.") + __properties: ClassVar[List[str]] = ["start", "end"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesDatamodelValidityRangeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesDatamodelValidityRangeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "start": obj.get("start"), + "end": obj.get("end") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_dto.py new file mode 100644 index 0000000000..048862afb8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_dto.py @@ -0,0 +1,128 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_dto import DataservicesQueryAggregationQuerySourceDTO +from visier_platform_sdk.models.dataservices_query_query_axis_dto import DataservicesQueryQueryAxisDTO +from visier_platform_sdk.models.dataservices_query_query_filter_dto import DataservicesQueryQueryFilterDTO +from visier_platform_sdk.models.dataservices_query_query_parameter_value_dto import DataservicesQueryQueryParameterValueDTO +from visier_platform_sdk.models.dataservices_query_query_time_intervals_dto import DataservicesQueryQueryTimeIntervalsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryAggregationQueryDTO(BaseModel): + """ + An AggregationQuery defines the data to query in an aggregation query and returns a `cell set` calculated from the selected data points. + """ # noqa: E501 + source: Optional[DataservicesQueryAggregationQuerySourceDTO] = Field(default=None, description="The source data, such as a metric or formula, to query.") + filters: Optional[List[DataservicesQueryQueryFilterDTO]] = Field(default=None, description="The objects by which to filter the query, such as dimensions or concepts. A filter defines the population to retrieve data from. Omit `filters` if no filtering is required.") + axes: Optional[List[DataservicesQueryQueryAxisDTO]] = Field(default=None, description="The objects by which to group the query. An axis defines the groups that the data belongs to. Omit `axes` if no grouping is required.") + time_intervals: Optional[DataservicesQueryQueryTimeIntervalsDTO] = Field(default=None, description="The time intervals to query.", alias="timeIntervals") + parameter_values: Optional[List[DataservicesQueryQueryParameterValueDTO]] = Field(default=None, description="The values associated with parameters, if defined.", alias="parameterValues") + __properties: ClassVar[List[str]] = ["source", "filters", "axes", "timeIntervals", "parameterValues"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationQueryDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of source + if self.source: + _dict['source'] = self.source.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in filters (list) + _items = [] + if self.filters: + for _item_filters in self.filters: + if _item_filters: + _items.append(_item_filters.to_dict()) + _dict['filters'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in axes (list) + _items = [] + if self.axes: + for _item_axes in self.axes: + if _item_axes: + _items.append(_item_axes.to_dict()) + _dict['axes'] = _items + # override the default output from pydantic by calling `to_dict()` of time_intervals + if self.time_intervals: + _dict['timeIntervals'] = self.time_intervals.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in parameter_values (list) + _items = [] + if self.parameter_values: + for _item_parameter_values in self.parameter_values: + if _item_parameter_values: + _items.append(_item_parameter_values.to_dict()) + _dict['parameterValues'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationQueryDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "source": DataservicesQueryAggregationQuerySourceDTO.from_dict(obj["source"]) if obj.get("source") is not None else None, + "filters": [DataservicesQueryQueryFilterDTO.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None, + "axes": [DataservicesQueryQueryAxisDTO.from_dict(_item) for _item in obj["axes"]] if obj.get("axes") is not None else None, + "timeIntervals": DataservicesQueryQueryTimeIntervalsDTO.from_dict(obj["timeIntervals"]) if obj.get("timeIntervals") is not None else None, + "parameterValues": [DataservicesQueryQueryParameterValueDTO.from_dict(_item) for _item in obj["parameterValues"]] if obj.get("parameterValues") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_execution_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_execution_dto.py new file mode 100644 index 0000000000..269a404779 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_execution_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_aggregation_query_dto import DataservicesQueryAggregationQueryDTO +from visier_platform_sdk.models.dataservices_query_query_execution_options_dto import DataservicesQueryQueryExecutionOptionsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryAggregationQueryExecutionDTO(BaseModel): + """ + An AggregationQueryExecution provides instructions to perform your aggregation query. + """ # noqa: E501 + query: Optional[DataservicesQueryAggregationQueryDTO] = Field(default=None, description="The data to perform an aggregation on, such as a metric or formula. The query must include a time interval, and may optionally include filters and axes.") + options: Optional[DataservicesQueryQueryExecutionOptionsDTO] = Field(default=None, description="Additional instructions for your query, such as a calendar type or conversion information.") + __properties: ClassVar[List[str]] = ["query", "options"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationQueryExecutionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of query + if self.query: + _dict['query'] = self.query.to_dict() + # override the default output from pydantic by calling `to_dict()` of options + if self.options: + _dict['options'] = self.options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationQueryExecutionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "query": DataservicesQueryAggregationQueryDTO.from_dict(obj["query"]) if obj.get("query") is not None else None, + "options": DataservicesQueryQueryExecutionOptionsDTO.from_dict(obj["options"]) if obj.get("options") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_source_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_source_dto.py new file mode 100644 index 0000000000..e1672bcd44 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_source_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_metrics_dto import DataservicesQueryAggregationQuerySourceMetricsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryAggregationQuerySourceDTO(BaseModel): + """ + An AggregationQuerySource defines the source data to query in an aggregation query. + """ # noqa: E501 + formula: Optional[StrictStr] = Field(default=None, description="An ad-hoc metric formula. The response returns the results of the aggregate. See the formula dictionary in Visier to find functions and objects you can use in a formula.") + metric: Optional[StrictStr] = Field(default=None, description="The ID of an existing metric in your Visier solution. See `Metrics` to get the ID.") + metrics: Optional[DataservicesQueryAggregationQuerySourceMetricsDTO] = Field(default=None, description="The IDs of metrics to aggregate. All metrics in the query must reference the same analytic object. For example, you cannot query Headcount and Applicant Count because one uses the Employee subject and the other uses the Applicant subject. You can query Headcount and Employee Count for Women because both reference the Employee subject. Only available when the Accept header is text/csv. For more information, see `Aggregate`.") + __properties: ClassVar[List[str]] = ["formula", "metric", "metrics"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationQuerySourceDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of metrics + if self.metrics: + _dict['metrics'] = self.metrics.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationQuerySourceDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "formula": obj.get("formula"), + "metric": obj.get("metric"), + "metrics": DataservicesQueryAggregationQuerySourceMetricsDTO.from_dict(obj["metrics"]) if obj.get("metrics") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_source_metric_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_source_metric_dto.py new file mode 100644 index 0000000000..d09364f00a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_source_metric_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryAggregationQuerySourceMetricDTO(BaseModel): + """ + The column definition for a single metric within a `metrics` query. + """ # noqa: E501 + column_name: Optional[StrictStr] = Field(default=None, description="The column name in the CSV file. Default is to use id as the column name.", alias="columnName") + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the metric. Note: See `Metrics` to get the ID. If columnName is omitted, id is the column name in the CSV file.") + formula: Optional[StrictStr] = Field(default=None, description="An ad-hoc metric formula. The response returns the results of the aggregate. See the formula dictionary in Visier to find functions and objects you can use in a formula.") + qualifying_path: Optional[StrictStr] = Field(default=None, description="The base qualifying path to prefix the axes and filters' qualifying paths with. You must specify the qualifying path on a metric if the convergent analytic object of the metric doesn't match the starting object in the qualifying paths of the axes and filters. For example, consider a multi-metric query that contains metrics that count the number of applicants and requisitions, grouped by the country of the recruiter's direct manager. The following sample shows how to use qualifyingPath to specify the object reference traversal path from each metric's convergent analytic object to the start of the path for the axes. In this example, there is only one convergent analytic object. ``` \"source\": { \"metrics\": { \"columns\": [ { \"id\": \"employeeCount\" }, { \"id\": \"applicantCount\", \"qualifyingPath\": \"Applicant.Requisition.Recruiter\" }, { \"id\": \"requisitionCount\", \"qualifyingPath\": \"Requisition.Recruiter\" } ] } }, \"axes\": [ { \"dimensionLevelSelection\": { \"dimension\": { \"name\": \"Location\", \"qualifyingPath\": \"Employee.Direct_Manager\" }, \"levelIds\": [ \"Location_1\" ] } } ] ``` **Note:** * `employeeCount` doesn't need a `qualifyingPath` because it's already convergent with the start of the axis path. * The metrics' qualifying paths must provide the reference name that resolves to the first object of the axis' qualifying path as their last path segment. In this case, Recruiter is a named reference pointing to Employee. The final qualifying paths for the metrics are: * `employeeCount`: Employee.Direct_Manager * `applicantCount`: Applicant.Requisition.Recruiter.Direct_Manager * `requisitionCount`: Requisition.Recruiter.Direct_Manager", alias="qualifyingPath") + __properties: ClassVar[List[str]] = ["columnName", "id", "formula", "qualifyingPath"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationQuerySourceMetricDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationQuerySourceMetricDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columnName": obj.get("columnName"), + "id": obj.get("id"), + "formula": obj.get("formula"), + "qualifyingPath": obj.get("qualifyingPath") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_source_metrics_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_source_metrics_dto.py new file mode 100644 index 0000000000..bc038e440b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_query_source_metrics_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_aggregation_query_source_metric_dto import DataservicesQueryAggregationQuerySourceMetricDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryAggregationQuerySourceMetricsDTO(BaseModel): + """ + The IDs and column names of multiple metrics. **Note:** Only available when the `Accept` header is text/csv. For more information, see `Aggregate` + """ # noqa: E501 + columns: Optional[List[DataservicesQueryAggregationQuerySourceMetricDTO]] = Field(default=None, description="An array of metric columns.") + __properties: ClassVar[List[str]] = ["columns"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationQuerySourceMetricsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in columns (list) + _items = [] + if self.columns: + for _item_columns in self.columns: + if _item_columns: + _items.append(_item_columns.to_dict()) + _dict['columns'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationQuerySourceMetricsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columns": [DataservicesQueryAggregationQuerySourceMetricDTO.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_type_parameter_value_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_type_parameter_value_dto.py new file mode 100644 index 0000000000..598c01cf26 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_aggregation_type_parameter_value_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryAggregationTypeParameterValueDTO(BaseModel): + """ + The value for an aggregation parameter. + """ # noqa: E501 + parameter_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the aggregation parameter.", alias="parameterId") + aggregation_option_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the aggregation option.", alias="aggregationOptionId") + __properties: ClassVar[List[str]] = ["parameterId", "aggregationOptionId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationTypeParameterValueDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryAggregationTypeParameterValueDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "parameterId": obj.get("parameterId"), + "aggregationOptionId": obj.get("aggregationOptionId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_distribution_bin_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_distribution_bin_dto.py new file mode 100644 index 0000000000..7c6dc99a49 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_distribution_bin_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryCellDistributionBinDTO(BaseModel): + """ + A cell distribution bin. Each bin has a metric value (of the bin) and the number of observations contributing to the bin. + """ # noqa: E501 + value: Optional[StrictStr] = None + support: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["value", "support"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryCellDistributionBinDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryCellDistributionBinDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "value": obj.get("value"), + "support": obj.get("support") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_distribution_options_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_distribution_options_dto.py new file mode 100644 index 0000000000..1a89b0b010 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_distribution_options_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryCellDistributionOptionsDTO(BaseModel): + """ + Cell distribution options for queries. Include with aggregation queries to enable distribution calculation per cell. + """ # noqa: E501 + bin_count: Optional[StrictInt] = Field(default=None, description="The number of bins to return, minimum of 2, and a maximum of 100.", alias="binCount") + __properties: ClassVar[List[str]] = ["binCount"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryCellDistributionOptionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryCellDistributionOptionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "binCount": obj.get("binCount") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_dto.py new file mode 100644 index 0000000000..e9fa3bb436 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_cell_distribution_bin_dto import DataservicesQueryCellDistributionBinDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryCellDTO(BaseModel): + """ + An individual value in a cell set. + """ # noqa: E501 + value: Optional[StrictStr] = Field(default=None, description="The value of the cell.") + support: Optional[StrictStr] = Field(default=None, description="The number of data points contributing to this cell.") + coordinates: Optional[List[StrictInt]] = Field(default=None, description="A list of integers representing the coordinates of this cell, identifying its position along each axis.") + distribution: Optional[List[DataservicesQueryCellDistributionBinDTO]] = Field(default=None, description="The optional distribution of this cell. This will be populated if distribution calculation is requested, and supported by the query.") + __properties: ClassVar[List[str]] = ["value", "support", "coordinates", "distribution"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryCellDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in distribution (list) + _items = [] + if self.distribution: + for _item_distribution in self.distribution: + if _item_distribution: + _items.append(_item_distribution.to_dict()) + _dict['distribution'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryCellDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "value": obj.get("value"), + "support": obj.get("support"), + "coordinates": obj.get("coordinates"), + "distribution": [DataservicesQueryCellDistributionBinDTO.from_dict(_item) for _item in obj["distribution"]] if obj.get("distribution") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_axis_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_axis_dto.py new file mode 100644 index 0000000000..64a50353c5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_axis_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from visier_platform_sdk.models.dataservices_query_cell_set_axis_position_dto import DataservicesQueryCellSetAxisPositionDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryCellSetAxisDTO(BaseModel): + """ + The axis of a cell set associated with a dimension. + """ # noqa: E501 + dimension: Optional[DataservicesDatamodelDimensionReferenceDTO] = Field(default=None, description="The dimension associated with the axis.") + positions: Optional[List[DataservicesQueryCellSetAxisPositionDTO]] = Field(default=None, description="A list of paths that represent the data's positions along the axis.") + __properties: ClassVar[List[str]] = ["dimension", "positions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryCellSetAxisDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dimension + if self.dimension: + _dict['dimension'] = self.dimension.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in positions (list) + _items = [] + if self.positions: + for _item_positions in self.positions: + if _item_positions: + _items.append(_item_positions.to_dict()) + _dict['positions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryCellSetAxisDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimension": DataservicesDatamodelDimensionReferenceDTO.from_dict(obj["dimension"]) if obj.get("dimension") is not None else None, + "positions": [DataservicesQueryCellSetAxisPositionDTO.from_dict(_item) for _item in obj["positions"]] if obj.get("positions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_axis_position_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_axis_position_dto.py new file mode 100644 index 0000000000..5d688bc11b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_axis_position_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryCellSetAxisPositionDTO(BaseModel): + """ + The position along the axis of a cell set. + """ # noqa: E501 + path: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing the members within a dimension path. For example, a dimension for Location may have the paths \"Canada, BC, Vancouver\" and \"US, California, San Francisco\".") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the position. This is optional and is omitted if unavailable or not requested.", alias="displayName") + display_name_path: Optional[List[StrictStr]] = Field(default=None, description="Optional display name path of the member.", alias="displayNamePath") + __properties: ClassVar[List[str]] = ["path", "displayName", "displayNamePath"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryCellSetAxisPositionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryCellSetAxisPositionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "path": obj.get("path"), + "displayName": obj.get("displayName"), + "displayNamePath": obj.get("displayNamePath") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_dto.py new file mode 100644 index 0000000000..9571f6d3b0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_dto.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_cell_dto import DataservicesQueryCellDTO +from visier_platform_sdk.models.dataservices_query_cell_set_axis_dto import DataservicesQueryCellSetAxisDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryCellSetDTO(BaseModel): + """ + The set of cells returned from executing an aggregation query. A CellSet represents a structured, multidimensional array of values. + """ # noqa: E501 + cells: Optional[List[DataservicesQueryCellDTO]] = Field(default=None, description="The set of cells that represent the result of your query.") + axes: Optional[List[DataservicesQueryCellSetAxisDTO]] = Field(default=None, description="The set of axes for the cell set that represent the objects the data is grouped by.") + lineage: Optional[DataservicesQueryLineageDTO] = Field(default=None, description="Lineage information for this cell set. This can be omitted if the cell has no lineage or the user did not request lineage information.") + __properties: ClassVar[List[str]] = ["cells", "axes", "lineage"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryCellSetDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in cells (list) + _items = [] + if self.cells: + for _item_cells in self.cells: + if _item_cells: + _items.append(_item_cells.to_dict()) + _dict['cells'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in axes (list) + _items = [] + if self.axes: + for _item_axes in self.axes: + if _item_axes: + _items.append(_item_axes.to_dict()) + _dict['axes'] = _items + # override the default output from pydantic by calling `to_dict()` of lineage + if self.lineage: + _dict['lineage'] = self.lineage.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryCellSetDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cells": [DataservicesQueryCellDTO.from_dict(_item) for _item in obj["cells"]] if obj.get("cells") is not None else None, + "axes": [DataservicesQueryCellSetAxisDTO.from_dict(_item) for _item in obj["axes"]] if obj.get("axes") is not None else None, + "lineage": DataservicesQueryLineageDTO.from_dict(obj["lineage"]) if obj.get("lineage") is not None else None + }) + return _obj + +from visier_platform_sdk.models.dataservices_query_lineage_dto import DataservicesQueryLineageDTO +# TODO: Rewrite to not use raise_errors +DataservicesQueryCellSetDTO.model_rebuild(raise_errors=False) + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_or_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_or_error_dto.py new file mode 100644 index 0000000000..a121df82fa --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cell_set_or_error_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_cell_set_dto import DataservicesQueryCellSetDTO +from visier_platform_sdk.models.dataservices_query_query_execution_error_dto import DataservicesQueryQueryExecutionErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryCellSetOrErrorDTO(BaseModel): + """ + A result that is either a cell set for a successful query execution, or an error for a failed query execution. + """ # noqa: E501 + cell_set: Optional[DataservicesQueryCellSetDTO] = Field(default=None, description="The resulting cell set from a successful query execution.", alias="cellSet") + error: Optional[DataservicesQueryQueryExecutionErrorDTO] = Field(default=None, description="An error for a failed query execution.") + __properties: ClassVar[List[str]] = ["cellSet", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryCellSetOrErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of cell_set + if self.cell_set: + _dict['cellSet'] = self.cell_set.to_dict() + # override the default output from pydantic by calling `to_dict()` of error + if self.error: + _dict['error'] = self.error.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryCellSetOrErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cellSet": DataservicesQueryCellSetDTO.from_dict(obj["cellSet"]) if obj.get("cellSet") is not None else None, + "error": DataservicesQueryQueryExecutionErrorDTO.from_dict(obj["error"]) if obj.get("error") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cohort_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cohort_filter_dto.py new file mode 100644 index 0000000000..c08d06379e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_cohort_filter_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_key_group_filter_dto import DataservicesQueryKeyGroupFilterDTO +from visier_platform_sdk.models.dataservices_query_query_time_interval_dto import DataservicesQueryQueryTimeIntervalDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryCohortFilterDTO(BaseModel): + """ + Use a cohort filter to define a population as it existed during a specific time period. Cohort filters allow you to define a population in terms of a collection of filters, known as a key group. The cohort's defined time interval is independent of the query's time. The cohort's time interval is the time at which the key group should be applied. Cohorts are typically used to follow populations and understand changes to the population over time, such as promotion and resignation rates. + """ # noqa: E501 + key_group: Optional[DataservicesQueryKeyGroupFilterDTO] = Field(default=None, description="A key group is a collection of filters that define the shape of the analysis population.", alias="keyGroup") + exclude: Optional[StrictBool] = Field(default=None, description="If true, the population is defined by those excluded by the filters. Default is false.") + time_interval: Optional[DataservicesQueryQueryTimeIntervalDTO] = Field(default=None, description="The time at which to apply the key group, such as a specific day or period of months.", alias="timeInterval") + __properties: ClassVar[List[str]] = ["keyGroup", "exclude", "timeInterval"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryCohortFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of key_group + if self.key_group: + _dict['keyGroup'] = self.key_group.to_dict() + # override the default output from pydantic by calling `to_dict()` of time_interval + if self.time_interval: + _dict['timeInterval'] = self.time_interval.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryCohortFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "keyGroup": DataservicesQueryKeyGroupFilterDTO.from_dict(obj["keyGroup"]) if obj.get("keyGroup") is not None else None, + "exclude": obj.get("exclude"), + "timeInterval": DataservicesQueryQueryTimeIntervalDTO.from_dict(obj["timeInterval"]) if obj.get("timeInterval") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_internal_query_execution_options_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_internal_query_execution_options_dto.py new file mode 100644 index 0000000000..f8384bd2b1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_internal_query_execution_options_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryInternalQueryExecutionOptionsDTO(BaseModel): + """ + Internal options - not to be documented or used by external parties + """ # noqa: E501 + sparse_handling_mode: Optional[StrictStr] = Field(default=None, alias="sparseHandlingMode") + align_time_axis_to_period_end: Optional[StrictBool] = Field(default=None, description="If true, shifts the time axis members back by one millisecond. Shifting the time axis members back by one millisecond makes them valid at the end of the period instead of at the start of the next period. This aligns the returned data timestamps with the timestamps in the Visier application. Example: If the timestamps are originally [`2019-06-01T00:00:00.000Z`, `2019-05-01T00:00:00.000Z`], then `alignTimeAxisPeriodEnd` turns the timestamps into [`2019-05-31T23:59:59.999Z`, `2019-04-30T23:59:59.999Z`]. Example: If the timestamps are originally [`2019-05-01T00:00:00.000Z/2019-06-01T00:00:00.000Z`, `2019-04-01T00:00:00.000Z/2019-05-01T00:00:00.000Z`], then `alignTimeAxisPeriodEnd` turns the timestamps into [`2019-05-01T00:00:00.000Z/2019-05-31T23:59:59.999Z`, `2019-04-01T00:00:00.000Z/2019-04-30T23:59:59.999Z`].", alias="alignTimeAxisToPeriodEnd") + __properties: ClassVar[List[str]] = ["sparseHandlingMode", "alignTimeAxisToPeriodEnd"] + + @field_validator('sparse_handling_mode') + def sparse_handling_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['ALLOW', 'DISALLOW', 'FORCE']): + raise ValueError("must be one of enum values ('ALLOW', 'DISALLOW', 'FORCE')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryInternalQueryExecutionOptionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryInternalQueryExecutionOptionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sparseHandlingMode": obj.get("sparseHandlingMode"), + "alignTimeAxisToPeriodEnd": obj.get("alignTimeAxisToPeriodEnd") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_key_group_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_key_group_filter_dto.py new file mode 100644 index 0000000000..d8beab22af --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_key_group_filter_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_key_group_filter_item_dto import DataservicesQueryKeyGroupFilterItemDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryKeyGroupFilterDTO(BaseModel): + """ + A collection of related filters that define a key group. + """ # noqa: E501 + filters: Optional[List[DataservicesQueryKeyGroupFilterItemDTO]] = None + __properties: ClassVar[List[str]] = ["filters"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryKeyGroupFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in filters (list) + _items = [] + if self.filters: + for _item_filters in self.filters: + if _item_filters: + _items.append(_item_filters.to_dict()) + _dict['filters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryKeyGroupFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "filters": [DataservicesQueryKeyGroupFilterItemDTO.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_key_group_filter_item_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_key_group_filter_item_dto.py new file mode 100644 index 0000000000..010c58c320 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_key_group_filter_item_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_reference_dto import DataservicesDatamodelSelectionConceptReferenceDTO +from visier_platform_sdk.models.dataservices_query_member_filter_dto import DataservicesQueryMemberFilterDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryKeyGroupFilterItemDTO(BaseModel): + """ + An individual filter in a key group. + """ # noqa: E501 + formula: Optional[StrictStr] = Field(default=None, description="A filter expressed as a formula.") + selection_concept: Optional[DataservicesDatamodelSelectionConceptReferenceDTO] = Field(default=None, description="A filter that uses an existing selection concept in Visier.", alias="selectionConcept") + member_set: Optional[DataservicesQueryMemberFilterDTO] = Field(default=None, description="A filter that includes or excludes dimension members.", alias="memberSet") + __properties: ClassVar[List[str]] = ["formula", "selectionConcept", "memberSet"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryKeyGroupFilterItemDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of selection_concept + if self.selection_concept: + _dict['selectionConcept'] = self.selection_concept.to_dict() + # override the default output from pydantic by calling `to_dict()` of member_set + if self.member_set: + _dict['memberSet'] = self.member_set.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryKeyGroupFilterItemDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "formula": obj.get("formula"), + "selectionConcept": DataservicesDatamodelSelectionConceptReferenceDTO.from_dict(obj["selectionConcept"]) if obj.get("selectionConcept") is not None else None, + "memberSet": DataservicesQueryMemberFilterDTO.from_dict(obj["memberSet"]) if obj.get("memberSet") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_lineage_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_lineage_dto.py new file mode 100644 index 0000000000..453a37311a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_lineage_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryLineageDTO(BaseModel): + """ + Lineage information for a given cell set. This describes how a cell set is created from other cell sets. + """ # noqa: E501 + cell_sets: Optional[List[DataservicesQueryCellSetDTO]] = Field(default=None, description="The cell sets that constitute this lineage.", alias="cellSets") + op: Optional[StrictStr] = Field(default=None, description="The operation used to combine the cell sets of this lineage.") + __properties: ClassVar[List[str]] = ["cellSets", "op"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryLineageDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in cell_sets (list) + _items = [] + if self.cell_sets: + for _item_cell_sets in self.cell_sets: + if _item_cell_sets: + _items.append(_item_cell_sets.to_dict()) + _dict['cellSets'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryLineageDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "cellSets": [DataservicesQueryCellSetDTO.from_dict(_item) for _item in obj["cellSets"]] if obj.get("cellSets") is not None else None, + "op": obj.get("op") + }) + return _obj + +from visier_platform_sdk.models.dataservices_query_cell_set_dto import DataservicesQueryCellSetDTO +# TODO: Rewrite to not use raise_errors +DataservicesQueryLineageDTO.model_rebuild(raise_errors=False) + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_list_query_execution_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_list_query_execution_dto.py new file mode 100644 index 0000000000..7354ee2240 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_list_query_execution_dto.py @@ -0,0 +1,144 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_list_query_execution_options_dto import DataservicesQueryListQueryExecutionOptionsDTO +from visier_platform_sdk.models.dataservices_query_list_query_source_dto import DataservicesQueryListQuerySourceDTO +from visier_platform_sdk.models.dataservices_query_property_column_dto import DataservicesQueryPropertyColumnDTO +from visier_platform_sdk.models.dataservices_query_query_filter_dto import DataservicesQueryQueryFilterDTO +from visier_platform_sdk.models.dataservices_query_query_parameter_value_dto import DataservicesQueryQueryParameterValueDTO +from visier_platform_sdk.models.dataservices_query_query_time_interval_dto import DataservicesQueryQueryTimeIntervalDTO +from visier_platform_sdk.models.dataservices_query_sort_option_dto import DataservicesQuerySortOptionDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryListQueryExecutionDTO(BaseModel): + """ + A ListQueryExecution provides instructions to perform a list query. + """ # noqa: E501 + source: Optional[DataservicesQueryListQuerySourceDTO] = Field(default=None, description="The source data that you want to query.") + columns: Optional[List[DataservicesQueryPropertyColumnDTO]] = Field(default=None, description="The columns to include in the result. This must contain at least one column.") + sort_options: Optional[List[DataservicesQuerySortOptionDTO]] = Field(default=None, description="The index and direction to sort a column in the `columns` array.", alias="sortOptions") + filters: Optional[List[DataservicesQueryQueryFilterDTO]] = Field(default=None, description="The filters of this query. Omit `filters` if no filtering is required.") + time_interval: Optional[DataservicesQueryQueryTimeIntervalDTO] = Field(default=None, description="The time that the data is valid, such as a specific day or period of months.", alias="timeInterval") + parameter_values: Optional[List[DataservicesQueryQueryParameterValueDTO]] = Field(default=None, description="The parameter values for either member or numeric parameters.", alias="parameterValues") + options: Optional[DataservicesQueryListQueryExecutionOptionsDTO] = Field(default=None, description="Additional instructions for your query, such as a calendar type or conversion information.") + __properties: ClassVar[List[str]] = ["source", "columns", "sortOptions", "filters", "timeInterval", "parameterValues", "options"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryListQueryExecutionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of source + if self.source: + _dict['source'] = self.source.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in columns (list) + _items = [] + if self.columns: + for _item_columns in self.columns: + if _item_columns: + _items.append(_item_columns.to_dict()) + _dict['columns'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in sort_options (list) + _items = [] + if self.sort_options: + for _item_sort_options in self.sort_options: + if _item_sort_options: + _items.append(_item_sort_options.to_dict()) + _dict['sortOptions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in filters (list) + _items = [] + if self.filters: + for _item_filters in self.filters: + if _item_filters: + _items.append(_item_filters.to_dict()) + _dict['filters'] = _items + # override the default output from pydantic by calling `to_dict()` of time_interval + if self.time_interval: + _dict['timeInterval'] = self.time_interval.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in parameter_values (list) + _items = [] + if self.parameter_values: + for _item_parameter_values in self.parameter_values: + if _item_parameter_values: + _items.append(_item_parameter_values.to_dict()) + _dict['parameterValues'] = _items + # override the default output from pydantic by calling `to_dict()` of options + if self.options: + _dict['options'] = self.options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryListQueryExecutionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "source": DataservicesQueryListQuerySourceDTO.from_dict(obj["source"]) if obj.get("source") is not None else None, + "columns": [DataservicesQueryPropertyColumnDTO.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None, + "sortOptions": [DataservicesQuerySortOptionDTO.from_dict(_item) for _item in obj["sortOptions"]] if obj.get("sortOptions") is not None else None, + "filters": [DataservicesQueryQueryFilterDTO.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None, + "timeInterval": DataservicesQueryQueryTimeIntervalDTO.from_dict(obj["timeInterval"]) if obj.get("timeInterval") is not None else None, + "parameterValues": [DataservicesQueryQueryParameterValueDTO.from_dict(_item) for _item in obj["parameterValues"]] if obj.get("parameterValues") is not None else None, + "options": DataservicesQueryListQueryExecutionOptionsDTO.from_dict(obj["options"]) if obj.get("options") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_list_query_execution_options_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_list_query_execution_options_dto.py new file mode 100644 index 0000000000..47daa4f613 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_list_query_execution_options_dto.py @@ -0,0 +1,158 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryListQueryExecutionOptionsDTO(BaseModel): + """ + A ListQueryExecutionOptions provides additional instructions to perform a list query. + """ # noqa: E501 + limit: Optional[StrictInt] = Field(default=None, description="The maximum number of entries to return. Default is to return all entries. If `page` is defined but limit is not defined, limit will be set to a default value of 1000.") + query_mode: Optional[StrictStr] = Field(default=None, description="Determines how the query should handle column definitions that the query is unable to resolve. Default is DEFAULT.", alias="queryMode") + omit_header: Optional[StrictBool] = Field(default=None, description="Option to omit the header from the result. If true, queryMode must be either FILL or FAIL. Default is false.", alias="omitHeader") + calendar_type: Optional[StrictStr] = Field(default=None, description="The calendar type to use. This will be used for all time calculations unless explicitly overridden in the calculation itself. Default is TENANT_CALENDAR.", alias="calendarType") + currency_conversion_mode: Optional[StrictStr] = Field(default=None, description="This option is deprecated. Use `currencyConversionCode` instead.", alias="currencyConversionMode") + currency_conversion_date: Optional[StrictStr] = Field(default=None, description="The currency conversion date to use. If defined, the currency conversion will use the exchange rates as of this date.", alias="currencyConversionDate") + page: Optional[StrictInt] = Field(default=None, description="A page defines a subset of the overall result set. The number of rows per page is equal to limit with the exception of the last page in the result set which may contain fewer rows. `Page` is an index that begins at 0. The index to start retrieving results is calculated by multiplying `page` by `limit`.") + multiple_tables: Optional[StrictBool] = Field(default=None, description="Option to return multiple table files as zipped archive for derived metrics. Default is false. If false, one table is returned for the drill-through metric.", alias="multipleTables") + currency_conversion_code: Optional[StrictStr] = Field(default=None, description="Overrides the tenant's default currency for currency conversions.", alias="currencyConversionCode") + record_mode: Optional[StrictStr] = Field(default=None, description="Influences the type of records used to build the result set, such as whether to return one record per entity that is valid in the provided time range or each change record falls in the time frame.", alias="recordMode") + date_time_display_mode: Optional[StrictStr] = Field(default=None, description="Control how date-time values are displayed in the result set. Supported values: * `EPOCH`: The number of elapsed milliseconds since January 1, 1970 in UTC timezone. This is the default. * `DATETIME`: The date-time value displayed in `yyyy-MM-dd HH:mm:ssZZ` format.", alias="dateTimeDisplayMode") + __properties: ClassVar[List[str]] = ["limit", "queryMode", "omitHeader", "calendarType", "currencyConversionMode", "currencyConversionDate", "page", "multipleTables", "currencyConversionCode", "recordMode", "dateTimeDisplayMode"] + + @field_validator('query_mode') + def query_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['DEFAULT', 'FILL', 'FAIL']): + raise ValueError("must be one of enum values ('DEFAULT', 'FILL', 'FAIL')") + return value + + @field_validator('calendar_type') + def calendar_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TENANT_CALENDAR', 'GREGORIAN_CALENDAR']): + raise ValueError("must be one of enum values ('TENANT_CALENDAR', 'GREGORIAN_CALENDAR')") + return value + + @field_validator('currency_conversion_mode') + def currency_conversion_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TENANT_CURRENCY_CONVERSION', 'VISIER_CURRENCY_CONVERSION']): + raise ValueError("must be one of enum values ('TENANT_CURRENCY_CONVERSION', 'VISIER_CURRENCY_CONVERSION')") + return value + + @field_validator('record_mode') + def record_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['NORMAL', 'CHANGES']): + raise ValueError("must be one of enum values ('NORMAL', 'CHANGES')") + return value + + @field_validator('date_time_display_mode') + def date_time_display_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['EPOCH', 'DATETIME']): + raise ValueError("must be one of enum values ('EPOCH', 'DATETIME')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryListQueryExecutionOptionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryListQueryExecutionOptionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "limit": obj.get("limit"), + "queryMode": obj.get("queryMode"), + "omitHeader": obj.get("omitHeader"), + "calendarType": obj.get("calendarType"), + "currencyConversionMode": obj.get("currencyConversionMode"), + "currencyConversionDate": obj.get("currencyConversionDate"), + "page": obj.get("page"), + "multipleTables": obj.get("multipleTables"), + "currencyConversionCode": obj.get("currencyConversionCode"), + "recordMode": obj.get("recordMode"), + "dateTimeDisplayMode": obj.get("dateTimeDisplayMode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_list_query_source_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_list_query_source_dto.py new file mode 100644 index 0000000000..c934ec51e2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_list_query_source_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryListQuerySourceDTO(BaseModel): + """ + A ListQuerySource defines the source data to query in a list query. + """ # noqa: E501 + formula: Optional[StrictStr] = Field(default=None, description="An ad-hoc metric formula. The response returns the individual data points that make up the aggregate.") + metric: Optional[StrictStr] = Field(default=None, description="The ID of an existing metric in your Visier solution.") + analytic_object: Optional[StrictStr] = Field(default=None, description="The ID of an existing analytic object in your Visier solution. An analytic object source cannot have filters or time handling.", alias="analyticObject") + text_concept: Optional[StrictStr] = Field(default=None, description="The ID of an existing text concept in your Visier solution. A concept that defines the text properties of an analytic object and includes filters to enforce aggregate thresholds.
**Note:** This field is in **limited availability**. If you are interested in using it, please contact your Customer Success Manager (CSM).", alias="textConcept") + __properties: ClassVar[List[str]] = ["formula", "metric", "analyticObject", "textConcept"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryListQuerySourceDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryListQuerySourceDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "formula": obj.get("formula"), + "metric": obj.get("metric"), + "analyticObject": obj.get("analyticObject"), + "textConcept": obj.get("textConcept") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_member_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_member_filter_dto.py new file mode 100644 index 0000000000..cbba10b71c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_member_filter_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_common_member_values_dto import DataservicesCommonMemberValuesDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryMemberFilterDTO(BaseModel): + """ + Member filters are dimension member values to filter by in your query. The member filters are defined within the filters section of a query definition. You can filter by dimension members in aggregate and list queries. + """ # noqa: E501 + dimension: Optional[DataservicesDatamodelDimensionReferenceDTO] = Field(default=None, description="The dimension in which the members belong.") + values: Optional[DataservicesCommonMemberValuesDTO] = Field(default=None, description="The dimension members to filter by.") + __properties: ClassVar[List[str]] = ["dimension", "values"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryMemberFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dimension + if self.dimension: + _dict['dimension'] = self.dimension.to_dict() + # override the default output from pydantic by calling `to_dict()` of values + if self.values: + _dict['values'] = self.values.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryMemberFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimension": DataservicesDatamodelDimensionReferenceDTO.from_dict(obj["dimension"]) if obj.get("dimension") is not None else None, + "values": DataservicesCommonMemberValuesDTO.from_dict(obj["values"]) if obj.get("values") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_member_parameter_value_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_member_parameter_value_dto.py new file mode 100644 index 0000000000..ddd3259f2c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_member_parameter_value_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_common_member_values_dto import DataservicesCommonMemberValuesDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryMemberParameterValueDTO(BaseModel): + """ + The member value of a parameter, including the parameter ID, dimension that the parameter is based on, and the included and excluded members for the parameter. + """ # noqa: E501 + parameter_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the member parameter qualified by the object.", alias="parameterId") + dimension_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the dimension on which the parameter is based.", alias="dimensionId") + reference_path: Optional[List[StrictStr]] = Field(default=None, description="The analytic object reference path from the metric to the dimension.", alias="referencePath") + values: Optional[DataservicesCommonMemberValuesDTO] = Field(default=None, description="The included and excluded member references in a dimension filter.") + __properties: ClassVar[List[str]] = ["parameterId", "dimensionId", "referencePath", "values"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryMemberParameterValueDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of values + if self.values: + _dict['values'] = self.values.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryMemberParameterValueDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "parameterId": obj.get("parameterId"), + "dimensionId": obj.get("dimensionId"), + "referencePath": obj.get("referencePath"), + "values": DataservicesCommonMemberValuesDTO.from_dict(obj["values"]) if obj.get("values") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_numeric_parameter_value_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_numeric_parameter_value_dto.py new file mode 100644 index 0000000000..82d835692d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_numeric_parameter_value_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryNumericParameterValueDTO(BaseModel): + """ + The value of a numeric parameter, including the parameter ID and the numeric value passed into the parameter. + """ # noqa: E501 + parameter_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the numeric parameter qualified by the object.", alias="parameterId") + value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The numeric value of the parameter.") + __properties: ClassVar[List[str]] = ["parameterId", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryNumericParameterValueDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryNumericParameterValueDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "parameterId": obj.get("parameterId"), + "value": obj.get("value") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_plan_parameter_value_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_plan_parameter_value_dto.py new file mode 100644 index 0000000000..d07bd5d23a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_plan_parameter_value_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryPlanParameterValueDTO(BaseModel): + """ + The value for a parameter on a planning metric, including the parameter ID and the plan the parameter is based on. + """ # noqa: E501 + parameter_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the plan parameter qualified by the object.", alias="parameterId") + plan_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the plan the parameter is based on.", alias="planId") + scenario_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the scenario the parameter is based on.", alias="scenarioId") + snapshot_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the snapshot the parameter is based on.", alias="snapshotId") + __properties: ClassVar[List[str]] = ["parameterId", "planId", "scenarioId", "snapshotId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryPlanParameterValueDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryPlanParameterValueDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "parameterId": obj.get("parameterId"), + "planId": obj.get("planId"), + "scenarioId": obj.get("scenarioId"), + "snapshotId": obj.get("snapshotId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_property_column_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_property_column_dto.py new file mode 100644 index 0000000000..e7f6da176a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_property_column_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_query_property_dto import DataservicesQueryQueryPropertyDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryPropertyColumnDTO(BaseModel): + """ + A named, result column of a list query. + """ # noqa: E501 + column_name: Optional[StrictStr] = Field(default=None, description="The name of the column. This is optional. If not specified, the name of the property is used, or a generic column name if the property is unnamed.", alias="columnName") + column_definition: Optional[DataservicesQueryQueryPropertyDTO] = Field(default=None, description="The definition of the property to query on.", alias="columnDefinition") + __properties: ClassVar[List[str]] = ["columnName", "columnDefinition"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryPropertyColumnDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of column_definition + if self.column_definition: + _dict['columnDefinition'] = self.column_definition.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryPropertyColumnDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columnName": obj.get("columnName"), + "columnDefinition": DataservicesQueryQueryPropertyDTO.from_dict(obj["columnDefinition"]) if obj.get("columnDefinition") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_axis_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_axis_dto.py new file mode 100644 index 0000000000..d7754487f2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_axis_dto.py @@ -0,0 +1,141 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_reference_dto import DataservicesDatamodelSelectionConceptReferenceDTO +from visier_platform_sdk.models.dataservices_query_query_axis_options_dto import DataservicesQueryQueryAxisOptionsDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_data_member_selection_dto import DataservicesQueryQueryDimensionDataMemberSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_leaf_selection_dto import DataservicesQueryQueryDimensionLeafSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_level_selection_dto import DataservicesQueryQueryDimensionLevelSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_member_selection_dto import DataservicesQueryQueryDimensionMemberSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_member_map_selection_dto import DataservicesQueryQueryMemberMapSelectionDTO +from visier_platform_sdk.models.dataservices_query_query_numeric_ranges_dto import DataservicesQueryQueryNumericRangesDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryAxisDTO(BaseModel): + """ + An axis of a query used to group data points. + """ # noqa: E501 + formula: Optional[StrictStr] = Field(default=None, description="An axis expressed as a formula.") + selection_concept: Optional[DataservicesDatamodelSelectionConceptReferenceDTO] = Field(default=None, description="An axis that uses an existing selection concept in Visier. The resulting axis consists of 3 positions: True, False, and Unknown.", alias="selectionConcept") + dimension_member_selection: Optional[DataservicesQueryQueryDimensionMemberSelectionDTO] = Field(default=None, description="An axis that uses existing dimension members in Visier.", alias="dimensionMemberSelection") + member_map_selection: Optional[DataservicesQueryQueryMemberMapSelectionDTO] = Field(default=None, description="An axis that uses an existing member map in Visier.", alias="memberMapSelection") + numeric_ranges: Optional[DataservicesQueryQueryNumericRangesDTO] = Field(default=None, description="An axis that uses an existing range dimension in Visier and defines the ranges to query.", alias="numericRanges") + dimension_level_selection: Optional[DataservicesQueryQueryDimensionLevelSelectionDTO] = Field(default=None, description="An axis that uses levels of existing dimensions in Visier.", alias="dimensionLevelSelection") + dimension_leaf_member_selection: Optional[DataservicesQueryQueryDimensionLeafSelectionDTO] = Field(default=None, description="An axis comprised of all non-data leaf members of an existing dimension in Visier.", alias="dimensionLeafMemberSelection") + dimension_data_member_selection: Optional[DataservicesQueryQueryDimensionDataMemberSelectionDTO] = Field(default=None, description="An axis comprised of all leaf, including data, members of an existing dimension in Visier.", alias="dimensionDataMemberSelection") + dimension_level_with_uncategorized_value_selection: Optional[DataservicesQueryQueryDimensionLevelSelectionDTO] = Field(default=None, description="An axis that uses existing dimension levels in Visier, including uncategorized levels.", alias="dimensionLevelWithUncategorizedValueSelection") + table_axis_options: Optional[DataservicesQueryQueryAxisOptionsDTO] = Field(default=None, description="Additional transformations to perform on this axis. Only available when the Accept header is a table format, such as text/csv or application/jsonlines.", alias="tableAxisOptions") + __properties: ClassVar[List[str]] = ["formula", "selectionConcept", "dimensionMemberSelection", "memberMapSelection", "numericRanges", "dimensionLevelSelection", "dimensionLeafMemberSelection", "dimensionDataMemberSelection", "dimensionLevelWithUncategorizedValueSelection", "tableAxisOptions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryAxisDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of selection_concept + if self.selection_concept: + _dict['selectionConcept'] = self.selection_concept.to_dict() + # override the default output from pydantic by calling `to_dict()` of dimension_member_selection + if self.dimension_member_selection: + _dict['dimensionMemberSelection'] = self.dimension_member_selection.to_dict() + # override the default output from pydantic by calling `to_dict()` of member_map_selection + if self.member_map_selection: + _dict['memberMapSelection'] = self.member_map_selection.to_dict() + # override the default output from pydantic by calling `to_dict()` of numeric_ranges + if self.numeric_ranges: + _dict['numericRanges'] = self.numeric_ranges.to_dict() + # override the default output from pydantic by calling `to_dict()` of dimension_level_selection + if self.dimension_level_selection: + _dict['dimensionLevelSelection'] = self.dimension_level_selection.to_dict() + # override the default output from pydantic by calling `to_dict()` of dimension_leaf_member_selection + if self.dimension_leaf_member_selection: + _dict['dimensionLeafMemberSelection'] = self.dimension_leaf_member_selection.to_dict() + # override the default output from pydantic by calling `to_dict()` of dimension_data_member_selection + if self.dimension_data_member_selection: + _dict['dimensionDataMemberSelection'] = self.dimension_data_member_selection.to_dict() + # override the default output from pydantic by calling `to_dict()` of dimension_level_with_uncategorized_value_selection + if self.dimension_level_with_uncategorized_value_selection: + _dict['dimensionLevelWithUncategorizedValueSelection'] = self.dimension_level_with_uncategorized_value_selection.to_dict() + # override the default output from pydantic by calling `to_dict()` of table_axis_options + if self.table_axis_options: + _dict['tableAxisOptions'] = self.table_axis_options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryAxisDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "formula": obj.get("formula"), + "selectionConcept": DataservicesDatamodelSelectionConceptReferenceDTO.from_dict(obj["selectionConcept"]) if obj.get("selectionConcept") is not None else None, + "dimensionMemberSelection": DataservicesQueryQueryDimensionMemberSelectionDTO.from_dict(obj["dimensionMemberSelection"]) if obj.get("dimensionMemberSelection") is not None else None, + "memberMapSelection": DataservicesQueryQueryMemberMapSelectionDTO.from_dict(obj["memberMapSelection"]) if obj.get("memberMapSelection") is not None else None, + "numericRanges": DataservicesQueryQueryNumericRangesDTO.from_dict(obj["numericRanges"]) if obj.get("numericRanges") is not None else None, + "dimensionLevelSelection": DataservicesQueryQueryDimensionLevelSelectionDTO.from_dict(obj["dimensionLevelSelection"]) if obj.get("dimensionLevelSelection") is not None else None, + "dimensionLeafMemberSelection": DataservicesQueryQueryDimensionLeafSelectionDTO.from_dict(obj["dimensionLeafMemberSelection"]) if obj.get("dimensionLeafMemberSelection") is not None else None, + "dimensionDataMemberSelection": DataservicesQueryQueryDimensionDataMemberSelectionDTO.from_dict(obj["dimensionDataMemberSelection"]) if obj.get("dimensionDataMemberSelection") is not None else None, + "dimensionLevelWithUncategorizedValueSelection": DataservicesQueryQueryDimensionLevelSelectionDTO.from_dict(obj["dimensionLevelWithUncategorizedValueSelection"]) if obj.get("dimensionLevelWithUncategorizedValueSelection") is not None else None, + "tableAxisOptions": DataservicesQueryQueryAxisOptionsDTO.from_dict(obj["tableAxisOptions"]) if obj.get("tableAxisOptions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_axis_options_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_axis_options_dto.py new file mode 100644 index 0000000000..a008705bba --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_axis_options_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryAxisOptionsDTO(BaseModel): + """ + QueryAxisOptions allows you to customize an axis in the query, such as changing the display mode for its cell set values or providing a custom column name. Only available when the Accept header is a table format, such as text/csv or application/jsonlines. + """ # noqa: E501 + member_display_mode: Optional[StrictStr] = Field(default=None, description="Options to override the display mode for the axis. This overrides the query-level `memberDisplayMode` options value in the query. Only available for non-time axes. Use the QueryAxisMemberDisplayMode `memberDisplayMode` to apply different display modes to different axes. For example, let's say your query has the `memberDisplayMode` as `DISPLAY` but you want to fetch the object name for a specific dimension. With QueryAxisMemberDisplayMode `memberDisplayMode`, you can override that dimension's `memberDisplayMode` to `DEFAULT` instead of `DISPLAY`. Valid values are `UNCHANGED`, `DEFAULT`, `COMPACT`, `DISPLAY`, or `MDX`. Default is `UNCHANGED`.", alias="memberDisplayMode") + column_name: Optional[StrictStr] = Field(default=None, description="If specified, returns the column name of the axis in the response.", alias="columnName") + __properties: ClassVar[List[str]] = ["memberDisplayMode", "columnName"] + + @field_validator('member_display_mode') + def member_display_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['UNCHANGED', 'DEFAULT', 'COMPACT', 'DISPLAY', 'MDX']): + raise ValueError("must be one of enum values ('UNCHANGED', 'DEFAULT', 'COMPACT', 'DISPLAY', 'MDX')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryAxisOptionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryAxisOptionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "memberDisplayMode": obj.get("memberDisplayMode"), + "columnName": obj.get("columnName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_data_member_selection_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_data_member_selection_dto.py new file mode 100644 index 0000000000..4bc4076214 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_data_member_selection_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryDimensionDataMemberSelectionDTO(BaseModel): + """ + A QueryDimensionLeafSelection allows you to define a member set consisting exclusively of leaf-level, including data, members for the given dimension. Leaf members are those members that have no descendents. A member may be a leaf member regardless of the level it is positioned at. + """ # noqa: E501 + dimension: Optional[DataservicesDatamodelDimensionReferenceDTO] = Field(default=None, description="A dimension and its qualifying path to query.") + __properties: ClassVar[List[str]] = ["dimension"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryDimensionDataMemberSelectionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dimension + if self.dimension: + _dict['dimension'] = self.dimension.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryDimensionDataMemberSelectionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimension": DataservicesDatamodelDimensionReferenceDTO.from_dict(obj["dimension"]) if obj.get("dimension") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_leaf_selection_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_leaf_selection_dto.py new file mode 100644 index 0000000000..98748b0ff7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_leaf_selection_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryDimensionLeafSelectionDTO(BaseModel): + """ + A QueryDimensionLeafSelection allows you to define a member set consisting exclusively of leaf-level members for the given dimension. Leaf members are those members that have no descendents. A member may be a leaf member regardless of the level it is positioned at. This member selection option, excludes data members. + """ # noqa: E501 + dimension: Optional[DataservicesDatamodelDimensionReferenceDTO] = Field(default=None, description="A dimension and its qualifying path to query.") + __properties: ClassVar[List[str]] = ["dimension"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryDimensionLeafSelectionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dimension + if self.dimension: + _dict['dimension'] = self.dimension.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryDimensionLeafSelectionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimension": DataservicesDatamodelDimensionReferenceDTO.from_dict(obj["dimension"]) if obj.get("dimension") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_level_property_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_level_property_dto.py new file mode 100644 index 0000000000..eabc3e68ab --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_level_property_dto.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryDimensionLevelPropertyDTO(BaseModel): + """ + A QueryDimensionLevelPropertyDTO defines an existing dimension level and its dimension to query. + """ # noqa: E501 + dimension: Optional[DataservicesDatamodelDimensionReferenceDTO] = Field(default=None, description="A dimension and its qualifying path to query.") + member_value_mode: Optional[StrictStr] = Field(default=None, description="Controls how to display member values. Valid values are `NAME`, `PATH`. * `NAME`: Returns the member's display name. This is the default. * `PATH`: Returns the member's name path.", alias="memberValueMode") + level_id: Optional[StrictStr] = Field(default=None, description="The level ID. For example, \"Level_1\" or \"Level_2\".", alias="levelId") + level_depth: Optional[StrictInt] = Field(default=None, description="The level depth. For a parent-child dimension, depth must be greater than 0. For example, 1 or 2.", alias="levelDepth") + __properties: ClassVar[List[str]] = ["dimension", "memberValueMode", "levelId", "levelDepth"] + + @field_validator('member_value_mode') + def member_value_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['NAME', 'PATH']): + raise ValueError("must be one of enum values ('NAME', 'PATH')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryDimensionLevelPropertyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dimension + if self.dimension: + _dict['dimension'] = self.dimension.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryDimensionLevelPropertyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimension": DataservicesDatamodelDimensionReferenceDTO.from_dict(obj["dimension"]) if obj.get("dimension") is not None else None, + "memberValueMode": obj.get("memberValueMode"), + "levelId": obj.get("levelId"), + "levelDepth": obj.get("levelDepth") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_level_selection_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_level_selection_dto.py new file mode 100644 index 0000000000..ae0d851cbf --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_level_selection_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryDimensionLevelSelectionDTO(BaseModel): + """ + A QueryDimensionLevelSelection allows you to select a dimension level and its members without explicitly listing each member. + """ # noqa: E501 + dimension: Optional[DataservicesDatamodelDimensionReferenceDTO] = Field(default=None, description="A dimension and its qualifying path to query.") + level_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of level IDs for the dimension levels that you want to query. For example, [\"Level_1\", \"Level_2\"]. To get a dimension's level IDs, call the Data Model API.", alias="levelIds") + level_depths: Optional[List[StrictInt]] = Field(default=None, description="A list of level depths for the dimension levels that you want to query. For a parent-child dimension, depth must be greater than 0. For example, [1, 2]. To get a dimension's level depths, call the Data Model API.", alias="levelDepths") + __properties: ClassVar[List[str]] = ["dimension", "levelIds", "levelDepths"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryDimensionLevelSelectionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dimension + if self.dimension: + _dict['dimension'] = self.dimension.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryDimensionLevelSelectionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimension": DataservicesDatamodelDimensionReferenceDTO.from_dict(obj["dimension"]) if obj.get("dimension") is not None else None, + "levelIds": obj.get("levelIds"), + "levelDepths": obj.get("levelDepths") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_member_selection_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_member_selection_dto.py new file mode 100644 index 0000000000..59781893b5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_dimension_member_selection_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_common_dimension_member_reference_dto import DataservicesCommonDimensionMemberReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryDimensionMemberSelectionDTO(BaseModel): + """ + A QueryDimensionMemberSelection defines dimension members to select in the query. + """ # noqa: E501 + dimension: Optional[DataservicesDatamodelDimensionReferenceDTO] = Field(default=None, description="A dimension and its qualifying path to query.") + members: Optional[List[DataservicesCommonDimensionMemberReferenceDTO]] = Field(default=None, description="A collection of dimension members to select in the query. This must contain at least one member.") + __properties: ClassVar[List[str]] = ["dimension", "members"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryDimensionMemberSelectionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of dimension + if self.dimension: + _dict['dimension'] = self.dimension.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in members (list) + _items = [] + if self.members: + for _item_members in self.members: + if _item_members: + _items.append(_item_members.to_dict()) + _dict['members'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryDimensionMemberSelectionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimension": DataservicesDatamodelDimensionReferenceDTO.from_dict(obj["dimension"]) if obj.get("dimension") is not None else None, + "members": [DataservicesCommonDimensionMemberReferenceDTO.from_dict(_item) for _item in obj["members"]] if obj.get("members") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_error_details_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_error_details_dto.py new file mode 100644 index 0000000000..458f59b30e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_error_details_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryExecutionErrorDetailsDTO(BaseModel): + """ + The details of a error that occurred during query execution. + """ # noqa: E501 + object_type: Optional[StrictStr] = Field(default=None, description="Query request object type.", alias="objectType") + query_index: Optional[StrictInt] = Field(default=None, description="The position of the query within the request query list.", alias="queryIndex") + column_index: Optional[StrictInt] = Field(default=None, description="The position of the column within the request column list.", alias="columnIndex") + error: Optional[StrictStr] = Field(default=None, description="The details of the error.") + __properties: ClassVar[List[str]] = ["objectType", "queryIndex", "columnIndex", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryExecutionErrorDetailsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryExecutionErrorDetailsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objectType": obj.get("objectType"), + "queryIndex": obj.get("queryIndex"), + "columnIndex": obj.get("columnIndex"), + "error": obj.get("error") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_error_dto.py new file mode 100644 index 0000000000..58b9848bb2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_error_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_query_execution_errors_dto import DataservicesQueryQueryExecutionErrorsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryExecutionErrorDTO(BaseModel): + """ + An error that occurred during query execution. A QueryExecutionError returns as part of a successful batch aggregation query for any queries that failed. This is different from errors, which return for failed requests. + """ # noqa: E501 + error_code: Optional[StrictStr] = Field(default=None, description="A brief identifier of the type of error.", alias="errorCode") + message: Optional[StrictStr] = Field(default=None, description="The details of the error.") + all_errors: Optional[List[DataservicesQueryQueryExecutionErrorsDTO]] = Field(default=None, description="All errors", alias="allErrors") + __properties: ClassVar[List[str]] = ["errorCode", "message", "allErrors"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryExecutionErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in all_errors (list) + _items = [] + if self.all_errors: + for _item_all_errors in self.all_errors: + if _item_all_errors: + _items.append(_item_all_errors.to_dict()) + _dict['allErrors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryExecutionErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "errorCode": obj.get("errorCode"), + "message": obj.get("message"), + "allErrors": [DataservicesQueryQueryExecutionErrorsDTO.from_dict(_item) for _item in obj["allErrors"]] if obj.get("allErrors") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_errors_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_errors_dto.py new file mode 100644 index 0000000000..b35f74c6ad --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_errors_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_query_execution_error_details_dto import DataservicesQueryQueryExecutionErrorDetailsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryExecutionErrorsDTO(BaseModel): + """ + The errors that occurred during query execution. + """ # noqa: E501 + error_code: Optional[StrictStr] = Field(default=None, description="A brief identifier of the type of error.", alias="errorCode") + message: Optional[StrictStr] = Field(default=None, description="The message of the error.") + all_error_details: Optional[List[DataservicesQueryQueryExecutionErrorDetailsDTO]] = Field(default=None, description="The list of the error details.", alias="allErrorDetails") + __properties: ClassVar[List[str]] = ["errorCode", "message", "allErrorDetails"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryExecutionErrorsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in all_error_details (list) + _items = [] + if self.all_error_details: + for _item_all_error_details in self.all_error_details: + if _item_all_error_details: + _items.append(_item_all_error_details.to_dict()) + _dict['allErrorDetails'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryExecutionErrorsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "errorCode": obj.get("errorCode"), + "message": obj.get("message"), + "allErrorDetails": [DataservicesQueryQueryExecutionErrorDetailsDTO.from_dict(_item) for _item in obj["allErrorDetails"]] if obj.get("allErrorDetails") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_options_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_options_dto.py new file mode 100644 index 0000000000..d09cd070b0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_execution_options_dto.py @@ -0,0 +1,192 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_cell_distribution_options_dto import DataservicesQueryCellDistributionOptionsDTO +from visier_platform_sdk.models.dataservices_query_internal_query_execution_options_dto import DataservicesQueryInternalQueryExecutionOptionsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryExecutionOptionsDTO(BaseModel): + """ + A QueryExecutionOptions provides additional instructions to perform a query. + """ # noqa: E501 + calendar_type: Optional[StrictStr] = Field(default=None, description="The calendar type to use. This will be used for all time calculations unless explicitly overridden in the calculation itself. Default is TENANT_CALENDAR.", alias="calendarType") + currency_conversion_mode: Optional[StrictStr] = Field(default=None, description="This option is deprecated. Use `currencyConversionCode` instead.", alias="currencyConversionMode") + currency_conversion_date: Optional[StrictStr] = Field(default=None, description="The currency conversion date to use. If defined, the currency conversion will use the exchange rates as of this date. Default is the exchange rate at the end of the query time interval. Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string. Note: Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent limitation in representing large numbers.", alias="currencyConversionDate") + lineage_depth: Optional[StrictInt] = Field(default=None, description="The max number of levels of nesting to unwind when determining the lineage for a derived metric value.", alias="lineageDepth") + zero_visibility: Optional[StrictStr] = Field(default=None, description="Show or hide zeros in the result. Default is SHOW.", alias="zeroVisibility") + null_visibility: Optional[StrictStr] = Field(default=None, description="Show or hide null or N/A values in the result. Default is SHOW.", alias="nullVisibility") + cell_distribution_options: Optional[DataservicesQueryCellDistributionOptionsDTO] = Field(default=None, alias="cellDistributionOptions") + axis_visibility: Optional[StrictStr] = Field(default=None, description="The amount of information to return about each axis. Default is SIMPLE.", alias="axisVisibility") + enable_sparse_results: Optional[StrictBool] = Field(default=None, description="Retrieve sparse cell sets. Sparse results only retrieve non-zero and non-null cells. Whether a result is truly sparse or not is determined by the Visier server.", alias="enableSparseResults") + internal: Optional[DataservicesQueryInternalQueryExecutionOptionsDTO] = None + enable_descending_space: Optional[StrictBool] = Field(default=None, description="If true, filter non-time axis member sets to only include members that are in aggregate positions or whose previous position is a leaf", alias="enableDescendingSpace") + currency_conversion_code: Optional[StrictStr] = Field(default=None, description="Overrides the tenant's default currency for currency conversions.", alias="currencyConversionCode") + member_display_mode: Optional[StrictStr] = Field(default=None, description="Control how member values are displayed. You can override the `memberDisplayMode` on a per-axis basis, if required. Valid values are `DEFAULT`, `COMPACT`, `DISPLAY`, or `MDX`. Default is `DEFAULT`. * `DEFAULT`: The default member name representation. For non-time members, this returns the technical member name path. For time members, this includes a bracketed member index. For example, Time instant member: `2019-06-01T00:00:00.000Z - [0]` For example, Time interval member: `2022-06-01T00:00:00.000Z/2022-07-01T00:00:00.000Z - [12]` * `COMPACT`: Shortens the member name representation. For time intervals, the member name is the end time of the interval. For example, Time instant member: `2019-06-01T00:00:00.000Z` For example, Time interval member: `2022-07-01T00:00:00.000Z` where the interval member name was `2022-06-01T00:00:00.000Z/2022-07-01T00:00:00.000Z - [12]` * `DISPLAY`: Emits the members' display names whenever possible. When combined with `axisVisibility = VERBOSE`, the full display name path will be emitted. * `MDX`: Emits member name paths where each element is enclosed in square brackets, `[]`. Multidimensional expression (MDX) display mode automatically encloses time members in square brackets and puts them in `COMPACT` format. For example, Location member `North America.United States.California` becomes `[North America].[United States].[California]` in MDX display mode. For example, Time instant member `2019-06-01T00:00:00.000Z - [0]` becomes `[2019-06-01T00:00:00.000Z]` in MDX display mode. * `COMPACT_DISPLAY`: Emit the members' display names after compacting. This applies primarily to time members for event-based metrics. Compact display is required when running multi-metric queries containing both event-based and subject-based metrics. Multi-metric queries with `DISPLAY` mode are changed automatically to `COMPACT_DISPLAY`. For example, Time interval member `2022-06-01T00:00:00.000Z/2022-07-01T00:00:00.000Z - [12]` becomes `Jun 30, 2022` in `COMPACT_DISPLAY` mode. The exact format of the compacted time member display name depends on the the user's locale.", alias="memberDisplayMode") + axes_overall_value_mode: Optional[StrictStr] = Field(default=None, description="If `axes` is defined, use `axesOverallValueMode` to specify the type of overall values to return across the axes. Valid values: * `NONE`: Returns the metric's values for the selected axes and doesn't return overall values. This is the default. * `AGGREGATE`: Returns the metric's overall values for the selected axes members. * `OVERALL`: Returns the metric's overall values for all axes members. **Note**: `AGGREGATE` is not supported for lookup overlays because the overall values of selected members cannot be calculated directly from the data. Example: Let's say you want to know the Headcount of the locations Canada and US and the genders Male and Female. When `axesOverallValueMode` is `NONE`, the query returns these values: * 100 (Canada, Male) * 100 (US, Male) * 100 (Canada, Female) * 100 (US, Female) When `axesOverallValueMode` is `AGGREGATE`, the query returns these values: * 100 (Canada, Male) * 100 (US, Male) * 100 (Canada, Female) * 100 (US, Female) * 400 (Overall, Overall) * 200 (Overall, Male) * 200 (Overall, Female) * 200 (Canada, Overall) * 200 (US, Overall) When `axesOverallValueMode` is `OVERALL`, the query returns these values: * 100 (Canada, Male) * 100 (US, Male) * 100 (Canada, Female) * 100 (US, Female) * 800 (Overall, Overall) * 400 (Overall, Male) * 400 (Overall, Female) * 400 (Canada, Overall) * 400 (US, Overall) In this example, `OVERALL` returns higher overall values than `AGGREGATE` because `AGGREGATE` returns the overall values for the selected locations (Canada, US) and genders (Male, Female), whereas `OVERALL` returns the overall values across all locations and genders in the data.", alias="axesOverallValueMode") + __properties: ClassVar[List[str]] = ["calendarType", "currencyConversionMode", "currencyConversionDate", "lineageDepth", "zeroVisibility", "nullVisibility", "cellDistributionOptions", "axisVisibility", "enableSparseResults", "internal", "enableDescendingSpace", "currencyConversionCode", "memberDisplayMode", "axesOverallValueMode"] + + @field_validator('calendar_type') + def calendar_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TENANT_CALENDAR', 'GREGORIAN_CALENDAR']): + raise ValueError("must be one of enum values ('TENANT_CALENDAR', 'GREGORIAN_CALENDAR')") + return value + + @field_validator('currency_conversion_mode') + def currency_conversion_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TENANT_CURRENCY_CONVERSION', 'VISIER_CURRENCY_CONVERSION']): + raise ValueError("must be one of enum values ('TENANT_CURRENCY_CONVERSION', 'VISIER_CURRENCY_CONVERSION')") + return value + + @field_validator('zero_visibility') + def zero_visibility_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SHOW', 'HIDE', 'ELIMINATE']): + raise ValueError("must be one of enum values ('SHOW', 'HIDE', 'ELIMINATE')") + return value + + @field_validator('null_visibility') + def null_visibility_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SHOW', 'HIDE', 'ELIMINATE']): + raise ValueError("must be one of enum values ('SHOW', 'HIDE', 'ELIMINATE')") + return value + + @field_validator('axis_visibility') + def axis_visibility_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SIMPLE', 'VERBOSE']): + raise ValueError("must be one of enum values ('SIMPLE', 'VERBOSE')") + return value + + @field_validator('member_display_mode') + def member_display_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['DEFAULT', 'COMPACT', 'DISPLAY', 'MDX', 'COMPACT_DISPLAY']): + raise ValueError("must be one of enum values ('DEFAULT', 'COMPACT', 'DISPLAY', 'MDX', 'COMPACT_DISPLAY')") + return value + + @field_validator('axes_overall_value_mode') + def axes_overall_value_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['NONE', 'AGGREGATE', 'OVERALL']): + raise ValueError("must be one of enum values ('NONE', 'AGGREGATE', 'OVERALL')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryExecutionOptionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of cell_distribution_options + if self.cell_distribution_options: + _dict['cellDistributionOptions'] = self.cell_distribution_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of internal + if self.internal: + _dict['internal'] = self.internal.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryExecutionOptionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "calendarType": obj.get("calendarType"), + "currencyConversionMode": obj.get("currencyConversionMode"), + "currencyConversionDate": obj.get("currencyConversionDate"), + "lineageDepth": obj.get("lineageDepth"), + "zeroVisibility": obj.get("zeroVisibility"), + "nullVisibility": obj.get("nullVisibility"), + "cellDistributionOptions": DataservicesQueryCellDistributionOptionsDTO.from_dict(obj["cellDistributionOptions"]) if obj.get("cellDistributionOptions") is not None else None, + "axisVisibility": obj.get("axisVisibility"), + "enableSparseResults": obj.get("enableSparseResults"), + "internal": DataservicesQueryInternalQueryExecutionOptionsDTO.from_dict(obj["internal"]) if obj.get("internal") is not None else None, + "enableDescendingSpace": obj.get("enableDescendingSpace"), + "currencyConversionCode": obj.get("currencyConversionCode"), + "memberDisplayMode": obj.get("memberDisplayMode"), + "axesOverallValueMode": obj.get("axesOverallValueMode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_filter_dto.py new file mode 100644 index 0000000000..227e4918dd --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_filter_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_reference_dto import DataservicesDatamodelSelectionConceptReferenceDTO +from visier_platform_sdk.models.dataservices_query_cohort_filter_dto import DataservicesQueryCohortFilterDTO +from visier_platform_sdk.models.dataservices_query_member_filter_dto import DataservicesQueryMemberFilterDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryFilterDTO(BaseModel): + """ + A QueryFilter selects specific data points within a population. + """ # noqa: E501 + formula: Optional[StrictStr] = Field(default=None, description="A filter expressed as a formula.") + selection_concept: Optional[DataservicesDatamodelSelectionConceptReferenceDTO] = Field(default=None, description="A filter that uses an existing selection concept in Visier.", alias="selectionConcept") + member_set: Optional[DataservicesQueryMemberFilterDTO] = Field(default=None, description="A filter that includes or excludes dimension members.", alias="memberSet") + cohort: Optional[DataservicesQueryCohortFilterDTO] = Field(default=None, description="A filter that identifies a population at a specific time.") + __properties: ClassVar[List[str]] = ["formula", "selectionConcept", "memberSet", "cohort"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of selection_concept + if self.selection_concept: + _dict['selectionConcept'] = self.selection_concept.to_dict() + # override the default output from pydantic by calling `to_dict()` of member_set + if self.member_set: + _dict['memberSet'] = self.member_set.to_dict() + # override the default output from pydantic by calling `to_dict()` of cohort + if self.cohort: + _dict['cohort'] = self.cohort.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "formula": obj.get("formula"), + "selectionConcept": DataservicesDatamodelSelectionConceptReferenceDTO.from_dict(obj["selectionConcept"]) if obj.get("selectionConcept") is not None else None, + "memberSet": DataservicesQueryMemberFilterDTO.from_dict(obj["memberSet"]) if obj.get("memberSet") is not None else None, + "cohort": DataservicesQueryCohortFilterDTO.from_dict(obj["cohort"]) if obj.get("cohort") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_member_map_property_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_member_map_property_dto.py new file mode 100644 index 0000000000..f422e3b749 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_member_map_property_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryMemberMapPropertyDTO(BaseModel): + """ + A QueryMemberMapProperty defines an existing member map and its dimension to query. + """ # noqa: E501 + member_map: Optional[DataservicesDatamodelDimensionReferenceDTO] = Field(default=None, description="A member map and its qualifying path to query.", alias="memberMap") + target_dimension_name: Optional[StrictStr] = Field(default=None, description="The name of the member map's dimension that you want to query. The member selection is based on this dimension.", alias="targetDimensionName") + __properties: ClassVar[List[str]] = ["memberMap", "targetDimensionName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryMemberMapPropertyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of member_map + if self.member_map: + _dict['memberMap'] = self.member_map.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryMemberMapPropertyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "memberMap": DataservicesDatamodelDimensionReferenceDTO.from_dict(obj["memberMap"]) if obj.get("memberMap") is not None else None, + "targetDimensionName": obj.get("targetDimensionName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_member_map_selection_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_member_map_selection_dto.py new file mode 100644 index 0000000000..a656aada88 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_member_map_selection_dto.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_common_dimension_member_reference_dto import DataservicesCommonDimensionMemberReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryMemberMapSelectionDTO(BaseModel): + """ + A QueryMemberMapSelection groups data in a query by dimension members in a member map. This allows grouping by a dimension that isn't typically valid on the analytic object being queried by selecting a valid member map on the analytic object. Note: This is unique to the data query API and cannot be reproduced in Visier's interface. + """ # noqa: E501 + member_map: Optional[DataservicesDatamodelDimensionReferenceDTO] = Field(default=None, description="A member map and its qualifying path to query.", alias="memberMap") + target_dimension_name: Optional[StrictStr] = Field(default=None, description="The name of the member map's dimension that you want to query. The member selection is based on this dimension.", alias="targetDimensionName") + members: Optional[List[DataservicesCommonDimensionMemberReferenceDTO]] = Field(default=None, description="A collection of the selected dimension members from the `targetDimension`. This must contain at least one member.") + __properties: ClassVar[List[str]] = ["memberMap", "targetDimensionName", "members"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryMemberMapSelectionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of member_map + if self.member_map: + _dict['memberMap'] = self.member_map.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in members (list) + _items = [] + if self.members: + for _item_members in self.members: + if _item_members: + _items.append(_item_members.to_dict()) + _dict['members'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryMemberMapSelectionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "memberMap": DataservicesDatamodelDimensionReferenceDTO.from_dict(obj["memberMap"]) if obj.get("memberMap") is not None else None, + "targetDimensionName": obj.get("targetDimensionName"), + "members": [DataservicesCommonDimensionMemberReferenceDTO.from_dict(_item) for _item in obj["members"]] if obj.get("members") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_numeric_ranges_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_numeric_ranges_dto.py new file mode 100644 index 0000000000..7814e21aac --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_numeric_ranges_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_query_property_dto import DataservicesQueryQueryPropertyDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryNumericRangesDTO(BaseModel): + """ + A QueryNumericRanges groups data into specified ranges based on a property value. + """ # noqa: E501 + var_property: Optional[DataservicesQueryQueryPropertyDTO] = Field(default=None, description="The name and qualifying path of a numeric property. Non-numeric properties are not accepted.", alias="property") + ranges: Optional[StrictStr] = Field(default=None, description="The ranges to group data into, expressed as a space-separated string of range-bound values.") + include_negative: Optional[StrictBool] = Field(default=None, description="If `true`, negative ranges are included. Default is false.", alias="includeNegative") + include_independent_zero_range: Optional[StrictBool] = Field(default=None, description="If `true`, 0 is an independent range. Default is false.", alias="includeIndependentZeroRange") + include_all_member: Optional[StrictBool] = Field(default=None, description="If `true`, a member is included that represents all members on the axis. Default is false.", alias="includeAllMember") + __properties: ClassVar[List[str]] = ["property", "ranges", "includeNegative", "includeIndependentZeroRange", "includeAllMember"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryNumericRangesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of var_property + if self.var_property: + _dict['property'] = self.var_property.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryNumericRangesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "property": DataservicesQueryQueryPropertyDTO.from_dict(obj["property"]) if obj.get("property") is not None else None, + "ranges": obj.get("ranges"), + "includeNegative": obj.get("includeNegative"), + "includeIndependentZeroRange": obj.get("includeIndependentZeroRange"), + "includeAllMember": obj.get("includeAllMember") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_parameter_value_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_parameter_value_dto.py new file mode 100644 index 0000000000..bb5b53dfdf --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_parameter_value_dto.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_aggregation_type_parameter_value_dto import DataservicesQueryAggregationTypeParameterValueDTO +from visier_platform_sdk.models.dataservices_query_member_parameter_value_dto import DataservicesQueryMemberParameterValueDTO +from visier_platform_sdk.models.dataservices_query_numeric_parameter_value_dto import DataservicesQueryNumericParameterValueDTO +from visier_platform_sdk.models.dataservices_query_plan_parameter_value_dto import DataservicesQueryPlanParameterValueDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryParameterValueDTO(BaseModel): + """ + An object that contains parameter values for either member or numeric parameters. + """ # noqa: E501 + member_value: Optional[DataservicesQueryMemberParameterValueDTO] = Field(default=None, description="A value for a member parameter.", alias="memberValue") + numeric_value: Optional[DataservicesQueryNumericParameterValueDTO] = Field(default=None, description="A value for a numeric parameter.", alias="numericValue") + plan_value: Optional[DataservicesQueryPlanParameterValueDTO] = Field(default=None, description="A value for a plan parameter.", alias="planValue") + aggregation_type_value: Optional[DataservicesQueryAggregationTypeParameterValueDTO] = Field(default=None, description="A value for an aggregation parameter.", alias="aggregationTypeValue") + __properties: ClassVar[List[str]] = ["memberValue", "numericValue", "planValue", "aggregationTypeValue"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryParameterValueDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of member_value + if self.member_value: + _dict['memberValue'] = self.member_value.to_dict() + # override the default output from pydantic by calling `to_dict()` of numeric_value + if self.numeric_value: + _dict['numericValue'] = self.numeric_value.to_dict() + # override the default output from pydantic by calling `to_dict()` of plan_value + if self.plan_value: + _dict['planValue'] = self.plan_value.to_dict() + # override the default output from pydantic by calling `to_dict()` of aggregation_type_value + if self.aggregation_type_value: + _dict['aggregationTypeValue'] = self.aggregation_type_value.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryParameterValueDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "memberValue": DataservicesQueryMemberParameterValueDTO.from_dict(obj["memberValue"]) if obj.get("memberValue") is not None else None, + "numericValue": DataservicesQueryNumericParameterValueDTO.from_dict(obj["numericValue"]) if obj.get("numericValue") is not None else None, + "planValue": DataservicesQueryPlanParameterValueDTO.from_dict(obj["planValue"]) if obj.get("planValue") is not None else None, + "aggregationTypeValue": DataservicesQueryAggregationTypeParameterValueDTO.from_dict(obj["aggregationTypeValue"]) if obj.get("aggregationTypeValue") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_property_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_property_dto.py new file mode 100644 index 0000000000..132671aa89 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_property_dto.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_datamodel_dimension_reference_dto import DataservicesDatamodelDimensionReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_property_reference_dto import DataservicesDatamodelPropertyReferenceDTO +from visier_platform_sdk.models.dataservices_datamodel_selection_concept_reference_dto import DataservicesDatamodelSelectionConceptReferenceDTO +from visier_platform_sdk.models.dataservices_query_query_dimension_level_property_dto import DataservicesQueryQueryDimensionLevelPropertyDTO +from visier_platform_sdk.models.dataservices_query_query_member_map_property_dto import DataservicesQueryQueryMemberMapPropertyDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryPropertyDTO(BaseModel): + """ + A QueryProperty defines a property of a data point returned from a query. This is not the same as a `property` in Visier's data mode. + """ # noqa: E501 + formula: Optional[StrictStr] = Field(default=None, description="A formula-based property.") + var_property: Optional[DataservicesDatamodelPropertyReferenceDTO] = Field(default=None, description="A property reference.", alias="property") + selection_concept: Optional[DataservicesDatamodelSelectionConceptReferenceDTO] = Field(default=None, description="A selection concept-based property that returns true or false.", alias="selectionConcept") + dimension: Optional[DataservicesDatamodelDimensionReferenceDTO] = Field(default=None, description="A dimension-based property that returns the full name path of the dimension member that the data point is mapped to.") + member_map_property: Optional[DataservicesQueryQueryMemberMapPropertyDTO] = Field(default=None, description="A member map-based property that uses an existing member map in Visier.", alias="memberMapProperty") + effective_date_property: Optional[Dict[str, Any]] = Field(default=None, description="A property that yields the effective date for the record", alias="effectiveDateProperty") + dimension_level_selection: Optional[DataservicesQueryQueryDimensionLevelPropertyDTO] = Field(default=None, description="A dimension-based property that returns the member values of the dimension level.", alias="dimensionLevelSelection") + __properties: ClassVar[List[str]] = ["formula", "property", "selectionConcept", "dimension", "memberMapProperty", "effectiveDateProperty", "dimensionLevelSelection"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryPropertyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of var_property + if self.var_property: + _dict['property'] = self.var_property.to_dict() + # override the default output from pydantic by calling `to_dict()` of selection_concept + if self.selection_concept: + _dict['selectionConcept'] = self.selection_concept.to_dict() + # override the default output from pydantic by calling `to_dict()` of dimension + if self.dimension: + _dict['dimension'] = self.dimension.to_dict() + # override the default output from pydantic by calling `to_dict()` of member_map_property + if self.member_map_property: + _dict['memberMapProperty'] = self.member_map_property.to_dict() + # override the default output from pydantic by calling `to_dict()` of dimension_level_selection + if self.dimension_level_selection: + _dict['dimensionLevelSelection'] = self.dimension_level_selection.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryPropertyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "formula": obj.get("formula"), + "property": DataservicesDatamodelPropertyReferenceDTO.from_dict(obj["property"]) if obj.get("property") is not None else None, + "selectionConcept": DataservicesDatamodelSelectionConceptReferenceDTO.from_dict(obj["selectionConcept"]) if obj.get("selectionConcept") is not None else None, + "dimension": DataservicesDatamodelDimensionReferenceDTO.from_dict(obj["dimension"]) if obj.get("dimension") is not None else None, + "memberMapProperty": DataservicesQueryQueryMemberMapPropertyDTO.from_dict(obj["memberMapProperty"]) if obj.get("memberMapProperty") is not None else None, + "effectiveDateProperty": obj.get("effectiveDateProperty"), + "dimensionLevelSelection": DataservicesQueryQueryDimensionLevelPropertyDTO.from_dict(obj["dimensionLevelSelection"]) if obj.get("dimensionLevelSelection") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_time_interval_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_time_interval_dto.py new file mode 100644 index 0000000000..8ae71304b6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_time_interval_dto.py @@ -0,0 +1,134 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_time_shift_dto import DataservicesQueryTimeShiftDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryTimeIntervalDTO(BaseModel): + """ + A QueryTimeInterval defines the time interval to query, including the \"from\" time, period type, period count, time direction, and shift to apply + """ # noqa: E501 + from_instant: Optional[StrictStr] = Field(default=None, description="The instant from which to extend in the specified `direction`, in milliseconds since 1970-01-01T00:00:00Z. Events that occur on this date are excluded. Subject-based data that ends on this date is included. Note: Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent limitation in representing large numbers.", alias="fromInstant") + from_date_time: Optional[StrictStr] = Field(default=None, description="The instant from which to extend in the specified `direction`, as an ISO-8601 formatted date time string. Valid formats: yyyy-MM-dd, yyyy-MM-dd'T'HH:mm:ss, yyyy-MM-dd'T'HH:mm:ss.SSS. Events that occur on this date are excluded. Subject-based data that ends on this date is included.", alias="fromDateTime") + dynamic_date_from: Optional[StrictStr] = Field(default=None, description="Dynamically select the date from which to extend in the specified `direction`. Valid values are `SOURCE` or `COMPLETE_PERIOD`. Both options determine the date using the request's `source` field. Whether the source is a metric, formula, or metrics, each source has earliest and latest data available dates to use. The `direction` determines whether the earliest or latest date is used. * If `dynamicDateFrom` is `SOURCE`, the query returns data from a date determined by the `source` query definition element. If `dynamicDateFrom` is `COMPLETE_PERIOD`, the query returns data starting from the latest or earliest date with a complete period of data. `COMPLETE_PERIOD` returns periods defined by `intervalPeriodType`. If the period type is MONTH, it returns full months of data. If the period type is YEAR, it returns full years of data. When `dynamicDateFrom` is specified: * If `source` is `metric`, then `dynamicDateFrom` considers the date range of available data for the metric. * If `source` is `formula`, then `dynamicDateFrom` considers the date range of available data for the metric in the formula. * If `source` is `analyticObject`, then `dynamicDateFrom` considers the date range of available data for the analytic object. Then, if `direction` is `BACKWARD`, query backward from the data **end** date and if `direction` is `FORWARD`, query forward from the data **start** date. This allows you to keep getting the latest or earliest data without changing your query every time there's new or updated data. Example: If a tenant has Headcount metric data available from 2023-01-01 to 2024-01-01 (End date exclusive), specifying `dynamicDateFrom`: `SOURCE` with `direction`: `BACKWARD` means the query will retrieve data backward from 2024-01-01. The effect is the same as if specifying a `fromDateTime` of 2024-01-01'T'00:00:00.000. Example: If a tenant has Employee subject data available from 2023-01-01 to 2024-01-01 (End date exclusive), specifying `dynamicDateFrom`: `SOURCE` with `direction`: `FORWARD` means the query will retrieve data forward from 2023-01-01. The effect is the same as if specifying a `fromDateTime` of 2023-01-01'T'00:00:00.000. Example: If a tenant has Employee subject data available from 2023-01-10 to 2023-04-01 (End date exclusive), specifying `dynamicDateFrom`: `COMPLETE_PERIOD` with `direction`: `FORWARD` means the query will retrieve data forward from 2023-02-01. The effect is the same as if specifying a `fromDateTime` of 2023-02-01'T'00:00:00.000. Example: If a tenant has Employee subject data available from 2023-01-01 to 2023-03-15 (End date exclusive), specifying `dynamicDateFrom`: `COMPLETE_PERIOD` with `direction`: `BACKWARD` means the query will retrieve data backward from 2023-03-01. The effect is the same as if specifying a `fromDateTime` of 2023-03-01'T'00:00:00.000. Example: Retrieve a list of EmployeeIDs for the formula extending 1 month backward from the dynamic source date { \"source\": { \"formula\": \"on Employee validUntil instant filterBy(isActiveEmployee) aggregate count(Employee.EmployeeID)\" }, \"columns\": [ { \"columnDefinition\": { \"property\": { \"name\": \"Employee.EmployeeID\", \"qualifyingPath\": \"Employee\" } } }, { \"columnDefinition\": { \"effectiveDateProperty\": {} } } ], \"timeInterval\": { \"dynamicDateFrom\": \"SOURCE\", \"intervalPeriodType\": \"MONTH\", \"intervalPeriodCount\": 1, \"direction\": \"BACKWARD\" } }", alias="dynamicDateFrom") + interval_period_type: Optional[StrictStr] = Field(default=None, description="The time period type for each interval. Default is MONTH.", alias="intervalPeriodType") + interval_period_count: Optional[StrictInt] = Field(default=None, description="The number of time periods per interval.", alias="intervalPeriodCount") + direction: Optional[StrictStr] = Field(default=None, description="The direction to extend. Default is BACKWARD. BACKWARD is useful when the time instant is the current date or with `dynamicDateFrom` because the query continuously retrieves the newest data from current date backwards.") + shift: Optional[DataservicesQueryTimeShiftDTO] = Field(default=None, description="The amount of time to shift the time interval by, such as backward by one year. Default is none.") + __properties: ClassVar[List[str]] = ["fromInstant", "fromDateTime", "dynamicDateFrom", "intervalPeriodType", "intervalPeriodCount", "direction", "shift"] + + @field_validator('dynamic_date_from') + def dynamic_date_from_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SOURCE', 'COMPLETE_PERIOD']): + raise ValueError("must be one of enum values ('SOURCE', 'COMPLETE_PERIOD')") + return value + + @field_validator('interval_period_type') + def interval_period_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MONTH', 'DAY', 'WEEK', 'QUARTER', 'YEAR']): + raise ValueError("must be one of enum values ('MONTH', 'DAY', 'WEEK', 'QUARTER', 'YEAR')") + return value + + @field_validator('direction') + def direction_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['BACKWARD', 'FORWARD']): + raise ValueError("must be one of enum values ('BACKWARD', 'FORWARD')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryTimeIntervalDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of shift + if self.shift: + _dict['shift'] = self.shift.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryTimeIntervalDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fromInstant": obj.get("fromInstant"), + "fromDateTime": obj.get("fromDateTime"), + "dynamicDateFrom": obj.get("dynamicDateFrom"), + "intervalPeriodType": obj.get("intervalPeriodType"), + "intervalPeriodCount": obj.get("intervalPeriodCount"), + "direction": obj.get("direction"), + "shift": DataservicesQueryTimeShiftDTO.from_dict(obj["shift"]) if obj.get("shift") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_time_intervals_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_time_intervals_dto.py new file mode 100644 index 0000000000..3ffccbdee0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_query_time_intervals_dto.py @@ -0,0 +1,150 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_time_shift_dto import DataservicesQueryTimeShiftDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryQueryTimeIntervalsDTO(BaseModel): + """ + A QueryTimeIntervals defines a series of time intervals to query, including the \"from\" time, period type, period count, number of intervals, time direction, and shift to apply to each time interval. + """ # noqa: E501 + from_instant: Optional[StrictStr] = Field(default=None, description="The instant from which to extend, in milliseconds since 1970-01-01T00:00:00Z. Events that occur on this date are excluded. Subject-based data that ends on this date is included. Note: Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent limitation in representing large numbers.", alias="fromInstant") + from_date_time: Optional[StrictStr] = Field(default=None, description="The instant from which to extend, as an ISO-8601 formatted date time string. This value is exclusive. Valid formats: yyyy-MM-dd, yyyy-MM-dd'T'HH:mm:ss, yyyy-MM-dd'T'HH:mm:ss.SSS. Events that occur on this date are excluded. Subject-based data that ends on this date is included.", alias="fromDateTime") + dynamic_date_from: Optional[StrictStr] = Field(default=None, description="Dynamically select the date from which to extend. Valid values are `SOURCE` or `COMPLETE_PERIOD`. Both options use the `source` query definition element to determine the date. If `dynamicDateFrom` is `SOURCE`, the query returns data from a date determined by the `source` query definition element. If `dynamicDateFrom` is `COMPLETE_PERIOD`, the query returns data starting from the latest or earliest date with a complete period of data. When `dynamicDateFrom` is specified: * If `source` is `metric`, then `dynamicDateFrom` considers the date range of available data for the metric. * If `source` is `formula`, then `dynamicDateFrom` considers the date range of available data for the metric in the formula. * If `source` is `metrics`, then `dynamicDateFrom` considers the date range of available data for the metric in the formula. Then, if `direction` is `BACKWARD`, query backward from the data **end** date and if `direction` is `FORWARD`, query forward from the data **start** date. This allows you to keep getting the latest or earliest data without changing your query every time there's new or updated data. Note: For multi-metric queries, if `direction` is `BACKWARD`, query backward from the earliest data end date of all metrics and if `direction` is `FORWARD`, query forward from the latest data start date of all metrics. This ensures that all metrics have data in the specified time range. Example: If a tenant has Headcount metric data available from 2023-01-01 to 2024-01-01 (End date exclusive), specifying `dynamicDateFrom`: `SOURCE` with `direction`: `BACKWARD` means the query will retrieve data backward from 2024-01-01. The effect is the same as if specifying a `fromDateTime` of 2024-01-01'T'00:00:00.000. Example: If a tenant has Employee subject data available from 2023-01-10 to 2023-04-01 (End date exclusive), specifying `dynamicDateFrom`: `COMPLETE_PERIOD` with `direction`: `FORWARD` means the query will retrieve data forward from 2023-02-01. The effect is the same as if specifying a `fromDateTime` of 2023-02-01'T'00:00:00.000. Example: If a tenant has Employee subject data available from 2023-01-01 to 2023-03-15 (End date exclusive), specifying `dynamicDateFrom`: `COMPLETE_PERIOD` with `direction`: `BACKWARD` means the query will retrieve data backward from 2023-03-01. The effect is the same as if specifying a `fromDateTime` of 2023-03-01'T'00:00:00.000. Example: If a tenant has Headcount data available from 2023-01-01 to 2024-09-01 and Exit Count data available from 2023-01-01 to 2024-01-01, specifying `dynamicDateFrom`: `SOURCE` with `direction`: `BACKWARD` means the query will retrieve data backward from 2024-01-01. Exit Count has an earlier data end date than Headcount, so `dynamicDateFrom` retrieves data backward from Exit Count's data end date to ensure both metrics have data in the specified time range. Example: Retrieve Headcount (employeeCount) extending 1 month backward from Headcount's dynamic source date { \"query\": { \"source\": { \"metric\": \"employeeCount\" }, \"timeIntervals\": { \"dynamicDateFrom\": \"SOURCE\", \"intervalPeriodType\": \"MONTH\", \"intervalCount\": 1, \"direction\": \"BACKWARD\" } } }", alias="dynamicDateFrom") + interval_period_type: Optional[StrictStr] = Field(default=None, description="The time period type for each interval. Default is MONTH.", alias="intervalPeriodType") + interval_period_count: Optional[StrictInt] = Field(default=None, description="The number of time periods per interval. Default is 1.", alias="intervalPeriodCount") + interval_count: Optional[StrictInt] = Field(default=None, description="The number of intervals. Default is 1.", alias="intervalCount") + direction: Optional[StrictStr] = Field(default=None, description="The direction to extend. Defaults is BACKWARD.") + shift: Optional[DataservicesQueryTimeShiftDTO] = Field(default=None, description="The amount of time to shift the time interval by, such as backward by one year.") + trailing_period_type: Optional[StrictStr] = Field(default=None, description="The time period type for each trailing period. If `trailingPeriodCount` is defined and `trailingPeriodType` is undefined, the default trailing period type is `MONTH`. If both `trailingPeriodType` and `trailingPeriodCount` are undefined, `intervalPeriodCount` is used as the trailing period count. Note: This parameter is only applicable to metrics that can calculate trailing time. If defined on a metric that doesn't have trailing time, the platform ignores the parameter.", alias="trailingPeriodType") + trailing_period_count: Optional[StrictInt] = Field(default=None, description="The number of time periods per trailing period. If `trailingPeriodType` is defined and `trailingPeriodCount` is undefined, the default trailing period count is 1. Note: This parameter is only applicable to metrics that can calculate trailing time. If defined on a metric that doesn't have trailing time, the platform ignores the parameter.", alias="trailingPeriodCount") + __properties: ClassVar[List[str]] = ["fromInstant", "fromDateTime", "dynamicDateFrom", "intervalPeriodType", "intervalPeriodCount", "intervalCount", "direction", "shift", "trailingPeriodType", "trailingPeriodCount"] + + @field_validator('dynamic_date_from') + def dynamic_date_from_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SOURCE', 'COMPLETE_PERIOD']): + raise ValueError("must be one of enum values ('SOURCE', 'COMPLETE_PERIOD')") + return value + + @field_validator('interval_period_type') + def interval_period_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MONTH', 'DAY', 'WEEK', 'QUARTER', 'YEAR']): + raise ValueError("must be one of enum values ('MONTH', 'DAY', 'WEEK', 'QUARTER', 'YEAR')") + return value + + @field_validator('direction') + def direction_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['BACKWARD', 'FORWARD']): + raise ValueError("must be one of enum values ('BACKWARD', 'FORWARD')") + return value + + @field_validator('trailing_period_type') + def trailing_period_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MONTH', 'DAY', 'WEEK', 'QUARTER', 'YEAR']): + raise ValueError("must be one of enum values ('MONTH', 'DAY', 'WEEK', 'QUARTER', 'YEAR')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryTimeIntervalsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of shift + if self.shift: + _dict['shift'] = self.shift.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryQueryTimeIntervalsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fromInstant": obj.get("fromInstant"), + "fromDateTime": obj.get("fromDateTime"), + "dynamicDateFrom": obj.get("dynamicDateFrom"), + "intervalPeriodType": obj.get("intervalPeriodType"), + "intervalPeriodCount": obj.get("intervalPeriodCount"), + "intervalCount": obj.get("intervalCount"), + "direction": obj.get("direction"), + "shift": DataservicesQueryTimeShiftDTO.from_dict(obj["shift"]) if obj.get("shift") is not None else None, + "trailingPeriodType": obj.get("trailingPeriodType"), + "trailingPeriodCount": obj.get("trailingPeriodCount") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_snapshot_query_execution_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_snapshot_query_execution_dto.py new file mode 100644 index 0000000000..a29223772c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_snapshot_query_execution_dto.py @@ -0,0 +1,144 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_list_query_source_dto import DataservicesQueryListQuerySourceDTO +from visier_platform_sdk.models.dataservices_query_property_column_dto import DataservicesQueryPropertyColumnDTO +from visier_platform_sdk.models.dataservices_query_query_filter_dto import DataservicesQueryQueryFilterDTO +from visier_platform_sdk.models.dataservices_query_query_parameter_value_dto import DataservicesQueryQueryParameterValueDTO +from visier_platform_sdk.models.dataservices_query_query_time_intervals_dto import DataservicesQueryQueryTimeIntervalsDTO +from visier_platform_sdk.models.dataservices_query_snapshot_query_execution_options_dto import DataservicesQuerySnapshotQueryExecutionOptionsDTO +from visier_platform_sdk.models.dataservices_query_sort_option_dto import DataservicesQuerySortOptionDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQuerySnapshotQueryExecutionDTO(BaseModel): + """ + DataservicesQuerySnapshotQueryExecutionDTO + """ # noqa: E501 + source: Optional[DataservicesQueryListQuerySourceDTO] = Field(default=None, description="The source data that you want to query.") + columns: Optional[List[DataservicesQueryPropertyColumnDTO]] = Field(default=None, description="The columns to include in the result. This must contain at least one column.") + sort_options: Optional[List[DataservicesQuerySortOptionDTO]] = Field(default=None, description="The index and direction to sort a column in the `columns` array.", alias="sortOptions") + filters: Optional[List[DataservicesQueryQueryFilterDTO]] = Field(default=None, description="The filters of this query. Omit `filters` if no filtering is required.") + time_intervals: Optional[DataservicesQueryQueryTimeIntervalsDTO] = Field(default=None, description="The time intervals to query.", alias="timeIntervals") + parameter_values: Optional[List[DataservicesQueryQueryParameterValueDTO]] = Field(default=None, description="The parameter values for either member or numeric parameters.", alias="parameterValues") + options: Optional[DataservicesQuerySnapshotQueryExecutionOptionsDTO] = Field(default=None, description="Additional instructions for your query, such as a calendar type or conversion information.") + __properties: ClassVar[List[str]] = ["source", "columns", "sortOptions", "filters", "timeIntervals", "parameterValues", "options"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQuerySnapshotQueryExecutionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of source + if self.source: + _dict['source'] = self.source.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in columns (list) + _items = [] + if self.columns: + for _item_columns in self.columns: + if _item_columns: + _items.append(_item_columns.to_dict()) + _dict['columns'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in sort_options (list) + _items = [] + if self.sort_options: + for _item_sort_options in self.sort_options: + if _item_sort_options: + _items.append(_item_sort_options.to_dict()) + _dict['sortOptions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in filters (list) + _items = [] + if self.filters: + for _item_filters in self.filters: + if _item_filters: + _items.append(_item_filters.to_dict()) + _dict['filters'] = _items + # override the default output from pydantic by calling `to_dict()` of time_intervals + if self.time_intervals: + _dict['timeIntervals'] = self.time_intervals.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in parameter_values (list) + _items = [] + if self.parameter_values: + for _item_parameter_values in self.parameter_values: + if _item_parameter_values: + _items.append(_item_parameter_values.to_dict()) + _dict['parameterValues'] = _items + # override the default output from pydantic by calling `to_dict()` of options + if self.options: + _dict['options'] = self.options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQuerySnapshotQueryExecutionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "source": DataservicesQueryListQuerySourceDTO.from_dict(obj["source"]) if obj.get("source") is not None else None, + "columns": [DataservicesQueryPropertyColumnDTO.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None, + "sortOptions": [DataservicesQuerySortOptionDTO.from_dict(_item) for _item in obj["sortOptions"]] if obj.get("sortOptions") is not None else None, + "filters": [DataservicesQueryQueryFilterDTO.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None, + "timeIntervals": DataservicesQueryQueryTimeIntervalsDTO.from_dict(obj["timeIntervals"]) if obj.get("timeIntervals") is not None else None, + "parameterValues": [DataservicesQueryQueryParameterValueDTO.from_dict(_item) for _item in obj["parameterValues"]] if obj.get("parameterValues") is not None else None, + "options": DataservicesQuerySnapshotQueryExecutionOptionsDTO.from_dict(obj["options"]) if obj.get("options") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_snapshot_query_execution_options_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_snapshot_query_execution_options_dto.py new file mode 100644 index 0000000000..e5e5da1127 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_snapshot_query_execution_options_dto.py @@ -0,0 +1,134 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQuerySnapshotQueryExecutionOptionsDTO(BaseModel): + """ + A SnapshotQueryExecutionOptions provides additional instructions to perform a snapshot query. + """ # noqa: E501 + limit: Optional[StrictInt] = Field(default=None, description="The maximum number of entries to return. Default is to return all entries. If `page` is defined but limit is not defined, limit will be set to a default value of 1000.") + query_mode: Optional[StrictStr] = Field(default=None, description="Determines how the query should handle column definitions that the query is unable to resolve. Default is DEFAULT.", alias="queryMode") + omit_header: Optional[StrictBool] = Field(default=None, description="Option to omit the header from the result. If true, queryMode must be either FILL or FAIL. Default is false.", alias="omitHeader") + calendar_type: Optional[StrictStr] = Field(default=None, description="The calendar type to use. This will be used for all time calculations unless explicitly overridden in the calculation itself. Default is TENANT_CALENDAR.", alias="calendarType") + currency_conversion_date: Optional[StrictStr] = Field(default=None, description="The currency conversion date to use. If defined, the currency conversion will use the exchange rates as of this date.", alias="currencyConversionDate") + page: Optional[StrictInt] = Field(default=None, description="A page defines a subset of the overall result set. The number of rows per page is equal to limit with the exception of the last page in the result set which may contain fewer rows. `Page` is an index that begins at 0. The index to start retrieving results is calculated by multiplying `page` by `limit`.") + multiple_tables: Optional[StrictBool] = Field(default=None, description="Option to return multiple table files as zipped archive for derived metrics. Default is false. If false, one table is returned for the drill-through metric.", alias="multipleTables") + currency_conversion_code: Optional[StrictStr] = Field(default=None, description="The optional target currency for all currency conversions. If not specified, the tenant default currency will be used.", alias="currencyConversionCode") + date_time_display_mode: Optional[StrictStr] = Field(default=None, description="Control how date-time values are displayed in the result set. Supported values: * `EPOCH`: The number of elapsed milliseconds since January 1, 1970 in UTC timezone. This is the default. * `DATETIME`: The date-time value displayed in `yyyy-MM-dd HH:mm:ssZZ` format.", alias="dateTimeDisplayMode") + __properties: ClassVar[List[str]] = ["limit", "queryMode", "omitHeader", "calendarType", "currencyConversionDate", "page", "multipleTables", "currencyConversionCode", "dateTimeDisplayMode"] + + @field_validator('query_mode') + def query_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['DEFAULT', 'FILL', 'FAIL']): + raise ValueError("must be one of enum values ('DEFAULT', 'FILL', 'FAIL')") + return value + + @field_validator('calendar_type') + def calendar_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['TENANT_CALENDAR', 'GREGORIAN_CALENDAR']): + raise ValueError("must be one of enum values ('TENANT_CALENDAR', 'GREGORIAN_CALENDAR')") + return value + + @field_validator('date_time_display_mode') + def date_time_display_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['EPOCH', 'DATETIME']): + raise ValueError("must be one of enum values ('EPOCH', 'DATETIME')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQuerySnapshotQueryExecutionOptionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQuerySnapshotQueryExecutionOptionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "limit": obj.get("limit"), + "queryMode": obj.get("queryMode"), + "omitHeader": obj.get("omitHeader"), + "calendarType": obj.get("calendarType"), + "currencyConversionDate": obj.get("currencyConversionDate"), + "page": obj.get("page"), + "multipleTables": obj.get("multipleTables"), + "currencyConversionCode": obj.get("currencyConversionCode"), + "dateTimeDisplayMode": obj.get("dateTimeDisplayMode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_sort_option_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_sort_option_dto.py new file mode 100644 index 0000000000..efee6a6e15 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_sort_option_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQuerySortOptionDTO(BaseModel): + """ + Sort option for a column of a list query. + """ # noqa: E501 + column_index: Optional[StrictInt] = Field(default=None, description="The index of the column of the list query, staring from 0.", alias="columnIndex") + sort_direction: Optional[StrictStr] = Field(default=None, description="The sort direction.", alias="sortDirection") + __properties: ClassVar[List[str]] = ["columnIndex", "sortDirection"] + + @field_validator('sort_direction') + def sort_direction_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SORT_ASCENDING', 'SORT_DESCENDING']): + raise ValueError("must be one of enum values ('SORT_ASCENDING', 'SORT_DESCENDING')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQuerySortOptionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQuerySortOptionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columnIndex": obj.get("columnIndex"), + "sortDirection": obj.get("sortDirection") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_sql_like_query_execution_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_sql_like_query_execution_dto.py new file mode 100644 index 0000000000..ef0fea4aec --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_sql_like_query_execution_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dataservices_query_query_execution_options_dto import DataservicesQueryQueryExecutionOptionsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQuerySqlLikeQueryExecutionDTO(BaseModel): + """ + * Request body for SQL-like query executions + """ # noqa: E501 + query: Optional[StrictStr] = Field(default=None, description="The SQL-like query string") + options: Optional[DataservicesQueryQueryExecutionOptionsDTO] = Field(default=None, description="Optional options that currently that cannot be expressed in SQL-like") + __properties: ClassVar[List[str]] = ["query", "options"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQuerySqlLikeQueryExecutionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of options + if self.options: + _dict['options'] = self.options.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQuerySqlLikeQueryExecutionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "query": obj.get("query"), + "options": DataservicesQueryQueryExecutionOptionsDTO.from_dict(obj["options"]) if obj.get("options") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_time_shift_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_time_shift_dto.py new file mode 100644 index 0000000000..0c2b734628 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dataservices_query_time_shift_dto.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DataservicesQueryTimeShiftDTO(BaseModel): + """ + The amount of time to shift the time interval by, such as backward by one year. + """ # noqa: E501 + period_type: Optional[StrictStr] = Field(default=None, description="The time period type for the shift.", alias="periodType") + period_count: Optional[StrictInt] = Field(default=None, description="The number of intervals. Default is 1.", alias="periodCount") + direction: Optional[StrictStr] = Field(default=None, description="The direction to extend. Default is BACKWARD.") + __properties: ClassVar[List[str]] = ["periodType", "periodCount", "direction"] + + @field_validator('period_type') + def period_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['MONTH', 'DAY', 'WEEK', 'QUARTER', 'YEAR']): + raise ValueError("must be one of enum values ('MONTH', 'DAY', 'WEEK', 'QUARTER', 'YEAR')") + return value + + @field_validator('direction') + def direction_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['BACKWARD', 'FORWARD']): + raise ValueError("must be one of enum values ('BACKWARD', 'FORWARD')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DataservicesQueryTimeShiftDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DataservicesQueryTimeShiftDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "periodType": obj.get("periodType"), + "periodCount": obj.get("periodCount"), + "direction": obj.get("direction") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/description_entry.py b/src/visier_platform_sdk/visier_platform_sdk/models/description_entry.py new file mode 100644 index 0000000000..e46c9e099e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/description_entry.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DescriptionEntry(BaseModel): + """ + DescriptionEntry + """ # noqa: E501 + label: Optional[StrictStr] = Field(default=None, description="A word or phrase that describes a section of the member description. This field will be excluded from the response if the member description does not have sections. ") + text: Optional[StrictStr] = Field(default=None, description="The body text for a section of the member description. This field will be excluded from the response if the member description does not have sections. ") + __properties: ClassVar[List[str]] = ["label", "text"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DescriptionEntry from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DescriptionEntry from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "label": obj.get("label"), + "text": obj.get("text") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_adp_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_adp_auth_params_dto.py new file mode 100644 index 0000000000..41a3b57645 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_adp_auth_params_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerAdpAuthParamsDTO(BaseModel): + """ + DesignerAdpAuthParamsDTO + """ # noqa: E501 + auth_code: Optional[StrictStr] = Field(default=None, alias="authCode") + __properties: ClassVar[List[str]] = ["authCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerAdpAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerAdpAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authCode": obj.get("authCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_analytic_object_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_analytic_object_filter_dto.py new file mode 100644 index 0000000000..442f08bd9d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_analytic_object_filter_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_dimension_filter_dto import DesignerApiDimensionFilterDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiAnalyticObjectFilterDTO(BaseModel): + """ + DesignerApiAnalyticObjectFilterDTO + """ # noqa: E501 + analytic_object_uuid: Optional[StrictStr] = Field(default=None, description="The UUID of the analytic object used in the selection concept.", alias="analyticObjectUuid") + symbol_name: Optional[StrictStr] = Field(default=None, description="The symbol name of the analytic object.", alias="symbolName") + dimensions: Optional[List[DesignerApiDimensionFilterDTO]] = Field(default=None, description="A list of dimensions included in the concept.") + __properties: ClassVar[List[str]] = ["analyticObjectUuid", "symbolName", "dimensions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiAnalyticObjectFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensions (list) + _items = [] + if self.dimensions: + for _item_dimensions in self.dimensions: + if _item_dimensions: + _items.append(_item_dimensions.to_dict()) + _dict['dimensions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiAnalyticObjectFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjectUuid": obj.get("analyticObjectUuid"), + "symbolName": obj.get("symbolName"), + "dimensions": [DesignerApiDimensionFilterDTO.from_dict(_item) for _item in obj["dimensions"]] if obj.get("dimensions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_configuration_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_configuration_dto.py new file mode 100644 index 0000000000..98c5cb79e0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_configuration_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_perspective_configuration_dto import DesignerApiPerspectiveConfigurationDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiCalculationConceptConfigurationDTO(BaseModel): + """ + DesignerApiCalculationConceptConfigurationDTO + """ # noqa: E501 + perspectives: Optional[List[DesignerApiPerspectiveConfigurationDTO]] = Field(default=None, description="A list of objects representing the perspectives in the calculation concept.") + __properties: ClassVar[List[str]] = ["perspectives"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiCalculationConceptConfigurationDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in perspectives (list) + _items = [] + if self.perspectives: + for _item_perspectives in self.perspectives: + if _item_perspectives: + _items.append(_item_perspectives.to_dict()) + _dict['perspectives'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiCalculationConceptConfigurationDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "perspectives": [DesignerApiPerspectiveConfigurationDTO.from_dict(_item) for _item in obj["perspectives"]] if obj.get("perspectives") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_configuration_map_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_configuration_map_dto.py new file mode 100644 index 0000000000..6541d8b67e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_configuration_map_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_perspective_configuration_dto import DesignerApiPerspectiveConfigurationDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiCalculationConceptConfigurationMapDTO(BaseModel): + """ + The configuration to apply to the concept. + """ # noqa: E501 + perspectives_to_map: Optional[List[DesignerApiPerspectiveConfigurationDTO]] = Field(default=None, description="A list of objects representing the list of perspectives in the calculation concept.", alias="perspectivesToMap") + __properties: ClassVar[List[str]] = ["perspectivesToMap"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiCalculationConceptConfigurationMapDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in perspectives_to_map (list) + _items = [] + if self.perspectives_to_map: + for _item_perspectives_to_map in self.perspectives_to_map: + if _item_perspectives_to_map: + _items.append(_item_perspectives_to_map.to_dict()) + _dict['perspectivesToMap'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiCalculationConceptConfigurationMapDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "perspectivesToMap": [DesignerApiPerspectiveConfigurationDTO.from_dict(_item) for _item in obj["perspectivesToMap"]] if obj.get("perspectivesToMap") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_dto.py new file mode 100644 index 0000000000..b71df1ddfd --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_calculation_concept_configuration_dto import DesignerApiCalculationConceptConfigurationDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiCalculationConceptDTO(BaseModel): + """ + DesignerApiCalculationConceptDTO + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the calculation concept.") + name: Optional[StrictStr] = Field(default=None, description="The display name of the calculation concept.") + configuration: Optional[DesignerApiCalculationConceptConfigurationDTO] = Field(default=None, description="A list of objects representing the configuration for the calculation concept.") + __properties: ClassVar[List[str]] = ["uuid", "name", "configuration"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiCalculationConceptDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of configuration + if self.configuration: + _dict['configuration'] = self.configuration.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiCalculationConceptDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "name": obj.get("name"), + "configuration": DesignerApiCalculationConceptConfigurationDTO.from_dict(obj["configuration"]) if obj.get("configuration") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_list_dto.py new file mode 100644 index 0000000000..6ca651961f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_calculation_concept_list_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_calculation_concept_dto import DesignerApiCalculationConceptDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiCalculationConceptListDTO(BaseModel): + """ + DesignerApiCalculationConceptListDTO + """ # noqa: E501 + concepts: Optional[List[DesignerApiCalculationConceptDTO]] = Field(default=None, description="A list of objects representing calculation concepts.") + __properties: ClassVar[List[str]] = ["concepts"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiCalculationConceptListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in concepts (list) + _items = [] + if self.concepts: + for _item_concepts in self.concepts: + if _item_concepts: + _items.append(_item_concepts.to_dict()) + _dict['concepts'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiCalculationConceptListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "concepts": [DesignerApiCalculationConceptDTO.from_dict(_item) for _item in obj["concepts"]] if obj.get("concepts") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_concept_configuration_result_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_concept_configuration_result_dto.py new file mode 100644 index 0000000000..be02137686 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_concept_configuration_result_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiConceptConfigurationResultDTO(BaseModel): + """ + DesignerApiConceptConfigurationResultDTO + """ # noqa: E501 + concept_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the configured concept.", alias="conceptId") + project_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the system-generated project.", alias="projectId") + message: Optional[StrictStr] = Field(default=None, description="A meaningful message about the API result.") + __properties: ClassVar[List[str]] = ["conceptId", "projectId", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiConceptConfigurationResultDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiConceptConfigurationResultDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "conceptId": obj.get("conceptId"), + "projectId": obj.get("projectId"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_dimension_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_dimension_filter_dto.py new file mode 100644 index 0000000000..109dadbaf0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_dimension_filter_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_dimension_member_dto import DesignerApiDimensionMemberDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiDimensionFilterDTO(BaseModel): + """ + DesignerApiDimensionFilterDTO + """ # noqa: E501 + dimension_id: Optional[StrictStr] = Field(default=None, description="The UUID of the dimension.", alias="dimensionId") + symbol_name: Optional[StrictStr] = Field(default=None, description="The symbol name of the dimension.", alias="symbolName") + dimension_members: Optional[List[DesignerApiDimensionMemberDTO]] = Field(default=None, description="A list of dimension members to map to the perspective node. Note: If this array is empty, all dimension members will be removed for the node.", alias="dimensionMembers") + __properties: ClassVar[List[str]] = ["dimensionId", "symbolName", "dimensionMembers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiDimensionFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimension_members (list) + _items = [] + if self.dimension_members: + for _item_dimension_members in self.dimension_members: + if _item_dimension_members: + _items.append(_item_dimension_members.to_dict()) + _dict['dimensionMembers'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiDimensionFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionId": obj.get("dimensionId"), + "symbolName": obj.get("symbolName"), + "dimensionMembers": [DesignerApiDimensionMemberDTO.from_dict(_item) for _item in obj["dimensionMembers"]] if obj.get("dimensionMembers") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_dimension_member_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_dimension_member_dto.py new file mode 100644 index 0000000000..54e63e34aa --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_dimension_member_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiDimensionMemberDTO(BaseModel): + """ + DesignerApiDimensionMemberDTO + """ # noqa: E501 + dimension_member: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing the dimension members. Dimension members in a hierarchical dimension will have an array with multiple strings.", alias="dimensionMember") + __properties: ClassVar[List[str]] = ["dimensionMember"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiDimensionMemberDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiDimensionMemberDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionMember": obj.get("dimensionMember") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_perspective_configuration_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_perspective_configuration_dto.py new file mode 100644 index 0000000000..f2a06ef730 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_perspective_configuration_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_perspective_node_dto import DesignerApiPerspectiveNodeDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiPerspectiveConfigurationDTO(BaseModel): + """ + DesignerApiPerspectiveConfigurationDTO + """ # noqa: E501 + perspective_id: Optional[StrictStr] = Field(default=None, description="The UUID of the perspective.", alias="perspectiveId") + perspective_name: Optional[StrictStr] = Field(default=None, description="The display name of the perspective.", alias="perspectiveName") + perspective_nodes: Optional[List[DesignerApiPerspectiveNodeDTO]] = Field(default=None, description="A list of nodes in the perspective.", alias="perspectiveNodes") + __properties: ClassVar[List[str]] = ["perspectiveId", "perspectiveName", "perspectiveNodes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiPerspectiveConfigurationDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in perspective_nodes (list) + _items = [] + if self.perspective_nodes: + for _item_perspective_nodes in self.perspective_nodes: + if _item_perspective_nodes: + _items.append(_item_perspective_nodes.to_dict()) + _dict['perspectiveNodes'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiPerspectiveConfigurationDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "perspectiveId": obj.get("perspectiveId"), + "perspectiveName": obj.get("perspectiveName"), + "perspectiveNodes": [DesignerApiPerspectiveNodeDTO.from_dict(_item) for _item in obj["perspectiveNodes"]] if obj.get("perspectiveNodes") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_perspective_node_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_perspective_node_dto.py new file mode 100644 index 0000000000..732cfcf5d6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_perspective_node_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_analytic_object_filter_dto import DesignerApiAnalyticObjectFilterDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiPerspectiveNodeDTO(BaseModel): + """ + DesignerApiPerspectiveNodeDTO + """ # noqa: E501 + selection_concept_uuid: Optional[StrictStr] = Field(default=None, description="The UUID of the node's selection concept. Perspective nodes are generated as selection concepts to enable filtering.", alias="selectionConceptUuid") + symbol_name: Optional[StrictStr] = Field(default=None, description="The symbol name of the selection concept. For example, \"isExitActualSystemTermination\".", alias="symbolName") + analytic_object_filters: Optional[List[DesignerApiAnalyticObjectFilterDTO]] = Field(default=None, description="A list of analytic object filters indicating the analytic object and dimensions used for the selection concept.", alias="analyticObjectFilters") + __properties: ClassVar[List[str]] = ["selectionConceptUuid", "symbolName", "analyticObjectFilters"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiPerspectiveNodeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in analytic_object_filters (list) + _items = [] + if self.analytic_object_filters: + for _item_analytic_object_filters in self.analytic_object_filters: + if _item_analytic_object_filters: + _items.append(_item_analytic_object_filters.to_dict()) + _dict['analyticObjectFilters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiPerspectiveNodeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "selectionConceptUuid": obj.get("selectionConceptUuid"), + "symbolName": obj.get("symbolName"), + "analyticObjectFilters": [DesignerApiAnalyticObjectFilterDTO.from_dict(_item) for _item in obj["analyticObjectFilters"]] if obj.get("analyticObjectFilters") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_configuration_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_configuration_dto.py new file mode 100644 index 0000000000..163645c6ae --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_configuration_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_analytic_object_filter_dto import DesignerApiAnalyticObjectFilterDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiSelectionConceptConfigurationDTO(BaseModel): + """ + DesignerApiSelectionConceptConfigurationDTO + """ # noqa: E501 + analytic_object_filters: Optional[List[DesignerApiAnalyticObjectFilterDTO]] = Field(default=None, description="A list of analytic object filters indicating the analytic object and dimension used for this selection concept.", alias="analyticObjectFilters") + __properties: ClassVar[List[str]] = ["analyticObjectFilters"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiSelectionConceptConfigurationDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in analytic_object_filters (list) + _items = [] + if self.analytic_object_filters: + for _item_analytic_object_filters in self.analytic_object_filters: + if _item_analytic_object_filters: + _items.append(_item_analytic_object_filters.to_dict()) + _dict['analyticObjectFilters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiSelectionConceptConfigurationDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjectFilters": [DesignerApiAnalyticObjectFilterDTO.from_dict(_item) for _item in obj["analyticObjectFilters"]] if obj.get("analyticObjectFilters") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_configuration_map_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_configuration_map_dto.py new file mode 100644 index 0000000000..c1408c8440 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_configuration_map_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_analytic_object_filter_dto import DesignerApiAnalyticObjectFilterDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiSelectionConceptConfigurationMapDTO(BaseModel): + """ + DesignerApiSelectionConceptConfigurationMapDTO + """ # noqa: E501 + analytic_object_filters_to_map: Optional[List[DesignerApiAnalyticObjectFilterDTO]] = Field(default=None, description="A list of analytic object filters indicating the analytic object and dimension members used for the selection concept. Note: If this array is empty, all filters will be removed for the concept.", alias="analyticObjectFiltersToMap") + __properties: ClassVar[List[str]] = ["analyticObjectFiltersToMap"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiSelectionConceptConfigurationMapDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in analytic_object_filters_to_map (list) + _items = [] + if self.analytic_object_filters_to_map: + for _item_analytic_object_filters_to_map in self.analytic_object_filters_to_map: + if _item_analytic_object_filters_to_map: + _items.append(_item_analytic_object_filters_to_map.to_dict()) + _dict['analyticObjectFiltersToMap'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiSelectionConceptConfigurationMapDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjectFiltersToMap": [DesignerApiAnalyticObjectFilterDTO.from_dict(_item) for _item in obj["analyticObjectFiltersToMap"]] if obj.get("analyticObjectFiltersToMap") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_dto.py new file mode 100644 index 0000000000..1150356cfb --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_selection_concept_configuration_dto import DesignerApiSelectionConceptConfigurationDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiSelectionConceptDTO(BaseModel): + """ + DesignerApiSelectionConceptDTO + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the selection concept.") + name: Optional[StrictStr] = Field(default=None, description="The display name of the selection concept.") + configuration: Optional[DesignerApiSelectionConceptConfigurationDTO] = Field(default=None, description="A list of objects representing the configuration for the selection concept.") + __properties: ClassVar[List[str]] = ["uuid", "name", "configuration"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiSelectionConceptDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of configuration + if self.configuration: + _dict['configuration'] = self.configuration.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiSelectionConceptDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "name": obj.get("name"), + "configuration": DesignerApiSelectionConceptConfigurationDTO.from_dict(obj["configuration"]) if obj.get("configuration") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_list_dto.py new file mode 100644 index 0000000000..a46e453fe1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_api_selection_concept_list_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_api_selection_concept_dto import DesignerApiSelectionConceptDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerApiSelectionConceptListDTO(BaseModel): + """ + DesignerApiSelectionConceptListDTO + """ # noqa: E501 + concepts: Optional[List[DesignerApiSelectionConceptDTO]] = Field(default=None, description="A list of objects representing selection concepts.") + __properties: ClassVar[List[str]] = ["concepts"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerApiSelectionConceptListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in concepts (list) + _items = [] + if self.concepts: + for _item_concepts in self.concepts: + if _item_concepts: + _items.append(_item_concepts.to_dict()) + _dict['concepts'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerApiSelectionConceptListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "concepts": [DesignerApiSelectionConceptDTO.from_dict(_item) for _item in obj["concepts"]] if obj.get("concepts") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_bamboo_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_bamboo_auth_params_dto.py new file mode 100644 index 0000000000..071d34b0e2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_bamboo_auth_params_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerBambooAuthParamsDTO(BaseModel): + """ + DesignerBambooAuthParamsDTO + """ # noqa: E501 + access_key: Optional[StrictStr] = Field(default=None, alias="accessKey") + tenant_domain_name: Optional[StrictStr] = Field(default=None, alias="tenantDomainName") + __properties: ClassVar[List[str]] = ["accessKey", "tenantDomainName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerBambooAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerBambooAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "accessKey": obj.get("accessKey"), + "tenantDomainName": obj.get("tenantDomainName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_basic_s3_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_basic_s3_auth_params_dto.py new file mode 100644 index 0000000000..c834230b36 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_basic_s3_auth_params_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerBasicS3AuthParamsDTO(BaseModel): + """ + DesignerBasicS3AuthParamsDTO + """ # noqa: E501 + bucket_name: Optional[StrictStr] = Field(default=None, alias="bucketName") + bucket_region: Optional[StrictStr] = Field(default=None, alias="bucketRegion") + access_key: Optional[StrictStr] = Field(default=None, alias="accessKey") + secret_key: Optional[StrictStr] = Field(default=None, alias="secretKey") + path: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["bucketName", "bucketRegion", "accessKey", "secretKey", "path"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerBasicS3AuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerBasicS3AuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "bucketName": obj.get("bucketName"), + "bucketRegion": obj.get("bucketRegion"), + "accessKey": obj.get("accessKey"), + "secretKey": obj.get("secretKey"), + "path": obj.get("path") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_big_query_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_big_query_auth_params_dto.py new file mode 100644 index 0000000000..1837bc0f5b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_big_query_auth_params_dto.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_big_query_service_account_params_dto import DesignerBigQueryServiceAccountParamsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerBigQueryAuthParamsDTO(BaseModel): + """ + DesignerBigQueryAuthParamsDTO + """ # noqa: E501 + project_id: Optional[StrictStr] = Field(default=None, alias="projectId") + dataset_location: Optional[StrictStr] = Field(default=None, alias="datasetLocation") + refresh_token: Optional[StrictStr] = Field(default=None, alias="refreshToken") + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + default_dataset: Optional[StrictStr] = Field(default=None, alias="defaultDataset") + service_account_params: Optional[DesignerBigQueryServiceAccountParamsDTO] = Field(default=None, alias="serviceAccountParams") + __properties: ClassVar[List[str]] = ["projectId", "datasetLocation", "refreshToken", "clientId", "clientSecret", "defaultDataset", "serviceAccountParams"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerBigQueryAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of service_account_params + if self.service_account_params: + _dict['serviceAccountParams'] = self.service_account_params.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerBigQueryAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "projectId": obj.get("projectId"), + "datasetLocation": obj.get("datasetLocation"), + "refreshToken": obj.get("refreshToken"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "defaultDataset": obj.get("defaultDataset"), + "serviceAccountParams": DesignerBigQueryServiceAccountParamsDTO.from_dict(obj["serviceAccountParams"]) if obj.get("serviceAccountParams") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_big_query_service_account_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_big_query_service_account_params_dto.py new file mode 100644 index 0000000000..5f31d2df76 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_big_query_service_account_params_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerBigQueryServiceAccountParamsDTO(BaseModel): + """ + DesignerBigQueryServiceAccountParamsDTO + """ # noqa: E501 + service_account_email: Optional[StrictStr] = Field(default=None, alias="serviceAccountEmail") + private_key: Optional[StrictStr] = Field(default=None, alias="privateKey") + __properties: ClassVar[List[str]] = ["serviceAccountEmail", "privateKey"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerBigQueryServiceAccountParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerBigQueryServiceAccountParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "serviceAccountEmail": obj.get("serviceAccountEmail"), + "privateKey": obj.get("privateKey") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_copy_s3_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_copy_s3_auth_params_dto.py new file mode 100644 index 0000000000..c3b4513ef5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_copy_s3_auth_params_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerCopyS3AuthParamsDTO(BaseModel): + """ + DesignerCopyS3AuthParamsDTO + """ # noqa: E501 + iam_role: Optional[StrictStr] = Field(default=None, alias="iamRole") + __properties: ClassVar[List[str]] = ["iamRole"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerCopyS3AuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerCopyS3AuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "iamRole": obj.get("iamRole") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_credential_creation_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_credential_creation_api_response_dto.py new file mode 100644 index 0000000000..c9dd6d8b49 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_credential_creation_api_response_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_subject_missing_access_dto import DesignerSubjectMissingAccessDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerCredentialCreationAPIResponseDTO(BaseModel): + """ + DesignerCredentialCreationAPIResponseDTO + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The unique ID of the newly created credential.") + symbol_name: Optional[StrictStr] = Field(default=None, description="The symbol name of the newly created credential.", alias="symbolName") + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the newly created credential.", alias="objectName") + missing_connection_properties: Optional[List[DesignerSubjectMissingAccessDTO]] = Field(default=None, description="The properties that the credential cannot access despite successful authentication. This is only returned for authentications that do not grant access to all data.", alias="missingConnectionProperties") + __properties: ClassVar[List[str]] = ["uuid", "symbolName", "objectName", "missingConnectionProperties"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerCredentialCreationAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in missing_connection_properties (list) + _items = [] + if self.missing_connection_properties: + for _item_missing_connection_properties in self.missing_connection_properties: + if _item_missing_connection_properties: + _items.append(_item_missing_connection_properties.to_dict()) + _dict['missingConnectionProperties'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerCredentialCreationAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "symbolName": obj.get("symbolName"), + "objectName": obj.get("objectName"), + "missingConnectionProperties": [DesignerSubjectMissingAccessDTO.from_dict(_item) for _item in obj["missingConnectionProperties"]] if obj.get("missingConnectionProperties") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_generate_key_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_generate_key_request_dto.py new file mode 100644 index 0000000000..73ea73698d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_generate_key_request_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerCryptoGenerateKeyRequestDTO(BaseModel): + """ + The settings to define for an encryption key. + """ # noqa: E501 + key_name: Optional[StrictStr] = Field(default=None, description="The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 6 and 36 characters long.", alias="keyName") + expiry_date: Optional[StrictStr] = Field(default=None, description="The UTC expiration date of the key in ISO-8601 format. Must be between 2 and 10 years. Default is 2 years.", alias="expiryDate") + algorithm: Optional[StrictStr] = Field(default=None, description="The hash-based message authentication code and cryptographic hash function associated with the encryption key. Must be one of `HmacSHA224`, `HmacSHA256`, `HmacSHA384`, or `HmacSHA512`.") + __properties: ClassVar[List[str]] = ["keyName", "expiryDate", "algorithm"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerCryptoGenerateKeyRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerCryptoGenerateKeyRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "keyName": obj.get("keyName"), + "expiryDate": obj.get("expiryDate"), + "algorithm": obj.get("algorithm") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_key_pair_delete_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_key_pair_delete_response_dto.py new file mode 100644 index 0000000000..f98ea57e8f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_key_pair_delete_response_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerCryptoKeyPairDeleteResponseDTO(BaseModel): + """ + DesignerCryptoKeyPairDeleteResponseDTO + """ # noqa: E501 + key_id: Optional[StrictStr] = Field(default=None, description="The key ID in 16-letter hexadecimal format, including leading zeros.", alias="keyID") + __properties: ClassVar[List[str]] = ["keyID"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerCryptoKeyPairDeleteResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerCryptoKeyPairDeleteResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "keyID": obj.get("keyID") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_key_pair_generate_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_key_pair_generate_request_dto.py new file mode 100644 index 0000000000..4a5751507e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_key_pair_generate_request_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerCryptoKeyPairGenerateRequestDTO(BaseModel): + """ + DesignerCryptoKeyPairGenerateRequestDTO + """ # noqa: E501 + expiration_date: Optional[StrictStr] = Field(default=None, description="The UTC expiration date of the key in ISO-8601 format. Must be between 2 and 10 years. Default is 2 years.", alias="expirationDate") + __properties: ClassVar[List[str]] = ["expirationDate"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerCryptoKeyPairGenerateRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerCryptoKeyPairGenerateRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "expirationDate": obj.get("expirationDate") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_public_key_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_public_key_dto.py new file mode 100644 index 0000000000..c847a0ea6d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_public_key_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerCryptoPublicKeyDTO(BaseModel): + """ + DesignerCryptoPublicKeyDTO + """ # noqa: E501 + key_id: Optional[StrictStr] = Field(default=None, description="The key ID of the generated key pair in 16-letter hexadecimal format, including leading zeros.", alias="keyID") + date_generated: Optional[StrictStr] = Field(default=None, description="The UTC date that the key pair was generated in milliseconds since the Unix epoch.", alias="dateGenerated") + expiry_date: Optional[StrictStr] = Field(default=None, description="The UTC expiration date of the key in milliseconds since the Unix epoch.", alias="expiryDate") + recipient: Optional[StrictStr] = Field(default=None, description="The tenant code and creation date in milliseconds of the PGP key; for example, WFF_j1r_13490234234.") + public_key: Optional[StrictStr] = Field(default=None, description="The public key of the generated key pair.", alias="publicKey") + __properties: ClassVar[List[str]] = ["keyID", "dateGenerated", "expiryDate", "recipient", "publicKey"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerCryptoPublicKeyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerCryptoPublicKeyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "keyID": obj.get("keyID"), + "dateGenerated": obj.get("dateGenerated"), + "expiryDate": obj.get("expiryDate"), + "recipient": obj.get("recipient"), + "publicKey": obj.get("publicKey") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_public_keys_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_public_keys_dto.py new file mode 100644 index 0000000000..961e2ec5a6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_public_keys_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_crypto_public_key_dto import DesignerCryptoPublicKeyDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerCryptoPublicKeysDTO(BaseModel): + """ + DesignerCryptoPublicKeysDTO + """ # noqa: E501 + keys: Optional[List[DesignerCryptoPublicKeyDTO]] = Field(default=None, description="A list of the tenant's public keys.") + __properties: ClassVar[List[str]] = ["keys"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerCryptoPublicKeysDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in keys (list) + _items = [] + if self.keys: + for _item_keys in self.keys: + if _item_keys: + _items.append(_item_keys.to_dict()) + _dict['keys'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerCryptoPublicKeysDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "keys": [DesignerCryptoPublicKeyDTO.from_dict(_item) for _item in obj["keys"]] if obj.get("keys") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_tenant_encryption_key_details_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_tenant_encryption_key_details_dto.py new file mode 100644 index 0000000000..36c7055a29 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_tenant_encryption_key_details_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerCryptoTenantEncryptionKeyDetailsDTO(BaseModel): + """ + Information about who generated an encryption key, its key name, algorithm, generation date, and expiration date. + """ # noqa: E501 + key_name: Optional[StrictStr] = Field(default=None, description="The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 6 and 36 characters long.", alias="keyName") + algorithm: Optional[StrictStr] = Field(default=None, description="The hash-based message authentication code and cryptographic hash function associated with the encryption key.") + generated_by: Optional[StrictStr] = Field(default=None, description="The user who generated the key.", alias="generatedBy") + date_generated: Optional[StrictStr] = Field(default=None, description="The UTC date that the key was generated in milliseconds since the Unix epoch.", alias="dateGenerated") + expiry_date: Optional[StrictStr] = Field(default=None, description="The UTC expiration date of the key in milliseconds since the Unix epoch.", alias="expiryDate") + __properties: ClassVar[List[str]] = ["keyName", "algorithm", "generatedBy", "dateGenerated", "expiryDate"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerCryptoTenantEncryptionKeyDetailsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerCryptoTenantEncryptionKeyDetailsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "keyName": obj.get("keyName"), + "algorithm": obj.get("algorithm"), + "generatedBy": obj.get("generatedBy"), + "dateGenerated": obj.get("dateGenerated"), + "expiryDate": obj.get("expiryDate") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_tenant_encryption_key_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_tenant_encryption_key_dto.py new file mode 100644 index 0000000000..290e3343e4 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_crypto_tenant_encryption_key_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_crypto_tenant_encryption_key_details_dto import DesignerCryptoTenantEncryptionKeyDetailsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerCryptoTenantEncryptionKeyDTO(BaseModel): + """ + The details of an encryption key. + """ # noqa: E501 + detail: Optional[DesignerCryptoTenantEncryptionKeyDetailsDTO] = Field(default=None, description="Information about an encryption key.") + key: Optional[StrictStr] = Field(default=None, description="The encryption key value.") + __properties: ClassVar[List[str]] = ["detail", "key"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerCryptoTenantEncryptionKeyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of detail + if self.detail: + _dict['detail'] = self.detail.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerCryptoTenantEncryptionKeyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "detail": DesignerCryptoTenantEncryptionKeyDetailsDTO.from_dict(obj["detail"]) if obj.get("detail") is not None else None, + "key": obj.get("key") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_auth_information_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_auth_information_dto.py new file mode 100644 index 0000000000..760b1571de --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_auth_information_dto.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_data_provider_auth_params_dto import DesignerDataProviderAuthParamsDTO +from visier_platform_sdk.models.designer_data_provider_basic_information_dto import DesignerDataProviderBasicInformationDTO +from visier_platform_sdk.models.designer_data_provider_basic_metadata_dto import DesignerDataProviderBasicMetadataDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataProviderAuthInformationDTO(BaseModel): + """ + DesignerDataProviderAuthInformationDTO + """ # noqa: E501 + data_provider_auth_params: Optional[DesignerDataProviderAuthParamsDTO] = Field(default=None, description="The authentication information for the credential.", alias="dataProviderAuthParams") + data_provider_basic_information: Optional[DesignerDataProviderBasicInformationDTO] = Field(default=None, description="The display name and description for the credential.", alias="dataProviderBasicInformation") + data_provider_metadata: Optional[DesignerDataProviderBasicMetadataDTO] = Field(default=None, alias="dataProviderMetadata") + __properties: ClassVar[List[str]] = ["dataProviderAuthParams", "dataProviderBasicInformation", "dataProviderMetadata"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataProviderAuthInformationDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of data_provider_auth_params + if self.data_provider_auth_params: + _dict['dataProviderAuthParams'] = self.data_provider_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of data_provider_basic_information + if self.data_provider_basic_information: + _dict['dataProviderBasicInformation'] = self.data_provider_basic_information.to_dict() + # override the default output from pydantic by calling `to_dict()` of data_provider_metadata + if self.data_provider_metadata: + _dict['dataProviderMetadata'] = self.data_provider_metadata.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataProviderAuthInformationDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataProviderAuthParams": DesignerDataProviderAuthParamsDTO.from_dict(obj["dataProviderAuthParams"]) if obj.get("dataProviderAuthParams") is not None else None, + "dataProviderBasicInformation": DesignerDataProviderBasicInformationDTO.from_dict(obj["dataProviderBasicInformation"]) if obj.get("dataProviderBasicInformation") is not None else None, + "dataProviderMetadata": DesignerDataProviderBasicMetadataDTO.from_dict(obj["dataProviderMetadata"]) if obj.get("dataProviderMetadata") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_auth_params_dto.py new file mode 100644 index 0000000000..d5d285b02a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_auth_params_dto.py @@ -0,0 +1,344 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_adp_auth_params_dto import DesignerAdpAuthParamsDTO +from visier_platform_sdk.models.designer_bamboo_auth_params_dto import DesignerBambooAuthParamsDTO +from visier_platform_sdk.models.designer_basic_s3_auth_params_dto import DesignerBasicS3AuthParamsDTO +from visier_platform_sdk.models.designer_big_query_auth_params_dto import DesignerBigQueryAuthParamsDTO +from visier_platform_sdk.models.designer_copy_s3_auth_params_dto import DesignerCopyS3AuthParamsDTO +from visier_platform_sdk.models.designer_databricks_auth_params_dto import DesignerDatabricksAuthParamsDTO +from visier_platform_sdk.models.designer_dayforce_v2_auth_params_dto import DesignerDayforceV2AuthParamsDTO +from visier_platform_sdk.models.designer_dimensions_auth_params_dto import DesignerDimensionsAuthParamsDTO +from visier_platform_sdk.models.designer_fusion_auth_params_dto import DesignerFusionAuthParamsDTO +from visier_platform_sdk.models.designer_gong_auth_params_dto import DesignerGongAuthParamsDTO +from visier_platform_sdk.models.designer_google_sheets_auth_params_dto import DesignerGoogleSheetsAuthParamsDTO +from visier_platform_sdk.models.designer_google_workspace_auth_params_dto import DesignerGoogleWorkspaceAuthParamsDTO +from visier_platform_sdk.models.designer_greenhouse_auth_params_dto import DesignerGreenhouseAuthParamsDTO +from visier_platform_sdk.models.designer_icims_auth_params_dto import DesignerIcimsAuthParamsDTO +from visier_platform_sdk.models.designer_internal_s3_auth_params_dto import DesignerInternalS3AuthParamsDTO +from visier_platform_sdk.models.designer_jdbc_auth_params_dto import DesignerJdbcAuthParamsDTO +from visier_platform_sdk.models.designer_jira_auth_params_dto import DesignerJiraAuthParamsDTO +from visier_platform_sdk.models.designer_lever_auth_params_dto import DesignerLeverAuthParamsDTO +from visier_platform_sdk.models.designer_medallia_auth_params_dto import DesignerMedalliaAuthParamsDTO +from visier_platform_sdk.models.designer_microsoft365_auth_params_dto import DesignerMicrosoft365AuthParamsDTO +from visier_platform_sdk.models.designer_my_sql_auth_params_dto import DesignerMySqlAuthParamsDTO +from visier_platform_sdk.models.designer_namely_auth_params_dto import DesignerNamelyAuthParamsDTO +from visier_platform_sdk.models.designer_oracle_db_auth_params_dto import DesignerOracleDbAuthParamsDTO +from visier_platform_sdk.models.designer_qualtrics_auth_params_dto import DesignerQualtricsAuthParamsDTO +from visier_platform_sdk.models.designer_redshift_auth_params_dto import DesignerRedshiftAuthParamsDTO +from visier_platform_sdk.models.designer_salesforce_auth_params_dto import DesignerSalesforceAuthParamsDTO +from visier_platform_sdk.models.designer_salesforce_v2_auth_params_dto import DesignerSalesforceV2AuthParamsDTO +from visier_platform_sdk.models.designer_service_now_auth_params_dto import DesignerServiceNowAuthParamsDTO +from visier_platform_sdk.models.designer_service_now_v2_auth_params_dto import DesignerServiceNowV2AuthParamsDTO +from visier_platform_sdk.models.designer_slack_auth_params_dto import DesignerSlackAuthParamsDTO +from visier_platform_sdk.models.designer_snowflake_auth_params_dto import DesignerSnowflakeAuthParamsDTO +from visier_platform_sdk.models.designer_sql_server_auth_params_dto import DesignerSqlServerAuthParamsDTO +from visier_platform_sdk.models.designer_success_factors_auth_params_dto import DesignerSuccessFactorsAuthParamsDTO +from visier_platform_sdk.models.designer_ultimate_auth_params_dto import DesignerUltimateAuthParamsDTO +from visier_platform_sdk.models.designer_willow_auth_params_dto import DesignerWillowAuthParamsDTO +from visier_platform_sdk.models.designer_workday_auth_params_dto import DesignerWorkdayAuthParamsDTO +from visier_platform_sdk.models.designer_workday_raas_auth_params_dto import DesignerWorkdayRaasAuthParamsDTO +from visier_platform_sdk.models.designer_zoom_auth_params_dto import DesignerZoomAuthParamsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataProviderAuthParamsDTO(BaseModel): + """ + DesignerDataProviderAuthParamsDTO + """ # noqa: E501 + tenant_domain_name: Optional[StrictStr] = Field(default=None, alias="tenantDomainName") + provider: Optional[StrictStr] = Field(default=None, description="The data provider associated with the credential.") + bamboo_auth_params: Optional[DesignerBambooAuthParamsDTO] = Field(default=None, alias="bambooAuthParams") + greenhouse_auth_params: Optional[DesignerGreenhouseAuthParamsDTO] = Field(default=None, alias="greenhouseAuthParams") + google_sheets_auth_params: Optional[DesignerGoogleSheetsAuthParamsDTO] = Field(default=None, alias="googleSheetsAuthParams") + jira_auth_params: Optional[DesignerJiraAuthParamsDTO] = Field(default=None, alias="jiraAuthParams") + lever_auth_params: Optional[DesignerLeverAuthParamsDTO] = Field(default=None, alias="leverAuthParams") + namely_auth_params: Optional[DesignerNamelyAuthParamsDTO] = Field(default=None, alias="namelyAuthParams") + qualtrics_auth_params: Optional[DesignerQualtricsAuthParamsDTO] = Field(default=None, alias="qualtricsAuthParams") + salesforce_auth_params: Optional[DesignerSalesforceAuthParamsDTO] = Field(default=None, alias="salesforceAuthParams") + ultimate_auth_params: Optional[DesignerUltimateAuthParamsDTO] = Field(default=None, alias="ultimateAuthParams") + workday_auth_params: Optional[DesignerWorkdayAuthParamsDTO] = Field(default=None, alias="workdayAuthParams") + icims_auth_params: Optional[DesignerIcimsAuthParamsDTO] = Field(default=None, alias="icimsAuthParams") + service_now_auth_params: Optional[DesignerServiceNowAuthParamsDTO] = Field(default=None, alias="serviceNowAuthParams") + jdbc_auth_params: Optional[DesignerJdbcAuthParamsDTO] = Field(default=None, alias="jdbcAuthParams") + s3_auth_params: Optional[DesignerBasicS3AuthParamsDTO] = Field(default=None, alias="s3AuthParams") + internal_s3_auth_params: Optional[DesignerInternalS3AuthParamsDTO] = Field(default=None, alias="internalS3AuthParams") + copy_s3_auth_params: Optional[DesignerCopyS3AuthParamsDTO] = Field(default=None, alias="copyS3AuthParams") + redshift_auth_params: Optional[DesignerRedshiftAuthParamsDTO] = Field(default=None, alias="redshiftAuthParams") + snowflake_auth_params: Optional[DesignerSnowflakeAuthParamsDTO] = Field(default=None, alias="snowflakeAuthParams") + big_query_auth_params: Optional[DesignerBigQueryAuthParamsDTO] = Field(default=None, alias="bigQueryAuthParams") + sql_server_auth_params: Optional[DesignerSqlServerAuthParamsDTO] = Field(default=None, alias="sqlServerAuthParams") + dimensions_auth_params: Optional[DesignerDimensionsAuthParamsDTO] = Field(default=None, alias="dimensionsAuthParams") + willow_auth_params: Optional[DesignerWillowAuthParamsDTO] = Field(default=None, alias="willowAuthParams") + empty_auth_params: Optional[Dict[str, Any]] = Field(default=None, alias="emptyAuthParams") + success_factors_auth_params: Optional[DesignerSuccessFactorsAuthParamsDTO] = Field(default=None, alias="successFactorsAuthParams") + fusion_auth_params: Optional[DesignerFusionAuthParamsDTO] = Field(default=None, alias="fusionAuthParams") + adp_auth_params: Optional[DesignerAdpAuthParamsDTO] = Field(default=None, alias="adpAuthParams") + medallia_auth_params: Optional[DesignerMedalliaAuthParamsDTO] = Field(default=None, alias="medalliaAuthParams") + salesforce_v2_auth_params: Optional[DesignerSalesforceV2AuthParamsDTO] = Field(default=None, alias="salesforceV2AuthParams") + gong_auth_params: Optional[DesignerGongAuthParamsDTO] = Field(default=None, alias="gongAuthParams") + zoom_auth_params: Optional[DesignerZoomAuthParamsDTO] = Field(default=None, alias="zoomAuthParams") + dayforce_v2_auth_params: Optional[DesignerDayforceV2AuthParamsDTO] = Field(default=None, alias="dayforceV2AuthParams") + slack_auth_params: Optional[DesignerSlackAuthParamsDTO] = Field(default=None, alias="slackAuthParams") + my_sql_auth_params: Optional[DesignerMySqlAuthParamsDTO] = Field(default=None, alias="mySqlAuthParams") + workday_raas_auth_params: Optional[DesignerWorkdayRaasAuthParamsDTO] = Field(default=None, alias="workdayRaasAuthParams") + ms365_auth_params: Optional[DesignerMicrosoft365AuthParamsDTO] = Field(default=None, alias="ms365AuthParams") + google_workspace_auth_params: Optional[DesignerGoogleWorkspaceAuthParamsDTO] = Field(default=None, alias="googleWorkspaceAuthParams") + oracle_db_auth_params: Optional[DesignerOracleDbAuthParamsDTO] = Field(default=None, alias="oracleDbAuthParams") + service_now_v2_auth_params: Optional[DesignerServiceNowV2AuthParamsDTO] = Field(default=None, alias="serviceNowV2AuthParams") + databricks_auth_params: Optional[DesignerDatabricksAuthParamsDTO] = Field(default=None, alias="databricksAuthParams") + has_updates: Optional[StrictBool] = Field(default=None, alias="hasUpdates") + auth_context: Optional[StrictStr] = Field(default=None, alias="authContext") + __properties: ClassVar[List[str]] = ["tenantDomainName", "provider", "bambooAuthParams", "greenhouseAuthParams", "googleSheetsAuthParams", "jiraAuthParams", "leverAuthParams", "namelyAuthParams", "qualtricsAuthParams", "salesforceAuthParams", "ultimateAuthParams", "workdayAuthParams", "icimsAuthParams", "serviceNowAuthParams", "jdbcAuthParams", "s3AuthParams", "internalS3AuthParams", "copyS3AuthParams", "redshiftAuthParams", "snowflakeAuthParams", "bigQueryAuthParams", "sqlServerAuthParams", "dimensionsAuthParams", "willowAuthParams", "emptyAuthParams", "successFactorsAuthParams", "fusionAuthParams", "adpAuthParams", "medalliaAuthParams", "salesforceV2AuthParams", "gongAuthParams", "zoomAuthParams", "dayforceV2AuthParams", "slackAuthParams", "mySqlAuthParams", "workdayRaasAuthParams", "ms365AuthParams", "googleWorkspaceAuthParams", "oracleDbAuthParams", "serviceNowV2AuthParams", "databricksAuthParams", "hasUpdates", "authContext"] + + @field_validator('provider') + def provider_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Bamboo', 'GoogleSheets', 'Greenhouse', 'Jira', 'Lever', 'Namely', 'Qualtrics', 'Salesforce', 'UKG', 'Workday', 'Icims', 'ServiceNow', 'Jdbc', 'BasicS3', 'InternalS3', 'CopyS3', 'Redshift', 'Snowflake', 'BigQuery', 'SqlServer', 'Dimensions', 'IcimsPartnerProviderRedshift', 'Willow', 'SuccessFactors', 'IcimsV2', 'ADP', 'WorkdayV2', 'ServiceNowV2', 'Medallia', 'Fusion', 'SalesforceV2', 'Gong', 'Zoom', 'GoogleCalendar', 'UKGV2', 'DayforceV2', 'GoogleActivityReport', 'Slack', 'MySql', 'WorkdayRaas', 'Microsoft365', 'GoogleWorkspace', 'OracleDb', 'SmartRecruiters', 'WorkdayWQL', 'OEMCornerstone', 'Databricks', 'JiraV2']): + raise ValueError("must be one of enum values ('Bamboo', 'GoogleSheets', 'Greenhouse', 'Jira', 'Lever', 'Namely', 'Qualtrics', 'Salesforce', 'UKG', 'Workday', 'Icims', 'ServiceNow', 'Jdbc', 'BasicS3', 'InternalS3', 'CopyS3', 'Redshift', 'Snowflake', 'BigQuery', 'SqlServer', 'Dimensions', 'IcimsPartnerProviderRedshift', 'Willow', 'SuccessFactors', 'IcimsV2', 'ADP', 'WorkdayV2', 'ServiceNowV2', 'Medallia', 'Fusion', 'SalesforceV2', 'Gong', 'Zoom', 'GoogleCalendar', 'UKGV2', 'DayforceV2', 'GoogleActivityReport', 'Slack', 'MySql', 'WorkdayRaas', 'Microsoft365', 'GoogleWorkspace', 'OracleDb', 'SmartRecruiters', 'WorkdayWQL', 'OEMCornerstone', 'Databricks', 'JiraV2')") + return value + + @field_validator('auth_context') + def auth_context_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['DefaultDataExtraction', 'WorkplaceDynamicsDataExtraction', 'Notification']): + raise ValueError("must be one of enum values ('DefaultDataExtraction', 'WorkplaceDynamicsDataExtraction', 'Notification')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataProviderAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of bamboo_auth_params + if self.bamboo_auth_params: + _dict['bambooAuthParams'] = self.bamboo_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of greenhouse_auth_params + if self.greenhouse_auth_params: + _dict['greenhouseAuthParams'] = self.greenhouse_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of google_sheets_auth_params + if self.google_sheets_auth_params: + _dict['googleSheetsAuthParams'] = self.google_sheets_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of jira_auth_params + if self.jira_auth_params: + _dict['jiraAuthParams'] = self.jira_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of lever_auth_params + if self.lever_auth_params: + _dict['leverAuthParams'] = self.lever_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of namely_auth_params + if self.namely_auth_params: + _dict['namelyAuthParams'] = self.namely_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of qualtrics_auth_params + if self.qualtrics_auth_params: + _dict['qualtricsAuthParams'] = self.qualtrics_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of salesforce_auth_params + if self.salesforce_auth_params: + _dict['salesforceAuthParams'] = self.salesforce_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of ultimate_auth_params + if self.ultimate_auth_params: + _dict['ultimateAuthParams'] = self.ultimate_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of workday_auth_params + if self.workday_auth_params: + _dict['workdayAuthParams'] = self.workday_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of icims_auth_params + if self.icims_auth_params: + _dict['icimsAuthParams'] = self.icims_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of service_now_auth_params + if self.service_now_auth_params: + _dict['serviceNowAuthParams'] = self.service_now_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of jdbc_auth_params + if self.jdbc_auth_params: + _dict['jdbcAuthParams'] = self.jdbc_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of s3_auth_params + if self.s3_auth_params: + _dict['s3AuthParams'] = self.s3_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of internal_s3_auth_params + if self.internal_s3_auth_params: + _dict['internalS3AuthParams'] = self.internal_s3_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of copy_s3_auth_params + if self.copy_s3_auth_params: + _dict['copyS3AuthParams'] = self.copy_s3_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of redshift_auth_params + if self.redshift_auth_params: + _dict['redshiftAuthParams'] = self.redshift_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of snowflake_auth_params + if self.snowflake_auth_params: + _dict['snowflakeAuthParams'] = self.snowflake_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of big_query_auth_params + if self.big_query_auth_params: + _dict['bigQueryAuthParams'] = self.big_query_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of sql_server_auth_params + if self.sql_server_auth_params: + _dict['sqlServerAuthParams'] = self.sql_server_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of dimensions_auth_params + if self.dimensions_auth_params: + _dict['dimensionsAuthParams'] = self.dimensions_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of willow_auth_params + if self.willow_auth_params: + _dict['willowAuthParams'] = self.willow_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of success_factors_auth_params + if self.success_factors_auth_params: + _dict['successFactorsAuthParams'] = self.success_factors_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of fusion_auth_params + if self.fusion_auth_params: + _dict['fusionAuthParams'] = self.fusion_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of adp_auth_params + if self.adp_auth_params: + _dict['adpAuthParams'] = self.adp_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of medallia_auth_params + if self.medallia_auth_params: + _dict['medalliaAuthParams'] = self.medallia_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of salesforce_v2_auth_params + if self.salesforce_v2_auth_params: + _dict['salesforceV2AuthParams'] = self.salesforce_v2_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of gong_auth_params + if self.gong_auth_params: + _dict['gongAuthParams'] = self.gong_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of zoom_auth_params + if self.zoom_auth_params: + _dict['zoomAuthParams'] = self.zoom_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of dayforce_v2_auth_params + if self.dayforce_v2_auth_params: + _dict['dayforceV2AuthParams'] = self.dayforce_v2_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of slack_auth_params + if self.slack_auth_params: + _dict['slackAuthParams'] = self.slack_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of my_sql_auth_params + if self.my_sql_auth_params: + _dict['mySqlAuthParams'] = self.my_sql_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of workday_raas_auth_params + if self.workday_raas_auth_params: + _dict['workdayRaasAuthParams'] = self.workday_raas_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of ms365_auth_params + if self.ms365_auth_params: + _dict['ms365AuthParams'] = self.ms365_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of google_workspace_auth_params + if self.google_workspace_auth_params: + _dict['googleWorkspaceAuthParams'] = self.google_workspace_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of oracle_db_auth_params + if self.oracle_db_auth_params: + _dict['oracleDbAuthParams'] = self.oracle_db_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of service_now_v2_auth_params + if self.service_now_v2_auth_params: + _dict['serviceNowV2AuthParams'] = self.service_now_v2_auth_params.to_dict() + # override the default output from pydantic by calling `to_dict()` of databricks_auth_params + if self.databricks_auth_params: + _dict['databricksAuthParams'] = self.databricks_auth_params.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataProviderAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantDomainName": obj.get("tenantDomainName"), + "provider": obj.get("provider"), + "bambooAuthParams": DesignerBambooAuthParamsDTO.from_dict(obj["bambooAuthParams"]) if obj.get("bambooAuthParams") is not None else None, + "greenhouseAuthParams": DesignerGreenhouseAuthParamsDTO.from_dict(obj["greenhouseAuthParams"]) if obj.get("greenhouseAuthParams") is not None else None, + "googleSheetsAuthParams": DesignerGoogleSheetsAuthParamsDTO.from_dict(obj["googleSheetsAuthParams"]) if obj.get("googleSheetsAuthParams") is not None else None, + "jiraAuthParams": DesignerJiraAuthParamsDTO.from_dict(obj["jiraAuthParams"]) if obj.get("jiraAuthParams") is not None else None, + "leverAuthParams": DesignerLeverAuthParamsDTO.from_dict(obj["leverAuthParams"]) if obj.get("leverAuthParams") is not None else None, + "namelyAuthParams": DesignerNamelyAuthParamsDTO.from_dict(obj["namelyAuthParams"]) if obj.get("namelyAuthParams") is not None else None, + "qualtricsAuthParams": DesignerQualtricsAuthParamsDTO.from_dict(obj["qualtricsAuthParams"]) if obj.get("qualtricsAuthParams") is not None else None, + "salesforceAuthParams": DesignerSalesforceAuthParamsDTO.from_dict(obj["salesforceAuthParams"]) if obj.get("salesforceAuthParams") is not None else None, + "ultimateAuthParams": DesignerUltimateAuthParamsDTO.from_dict(obj["ultimateAuthParams"]) if obj.get("ultimateAuthParams") is not None else None, + "workdayAuthParams": DesignerWorkdayAuthParamsDTO.from_dict(obj["workdayAuthParams"]) if obj.get("workdayAuthParams") is not None else None, + "icimsAuthParams": DesignerIcimsAuthParamsDTO.from_dict(obj["icimsAuthParams"]) if obj.get("icimsAuthParams") is not None else None, + "serviceNowAuthParams": DesignerServiceNowAuthParamsDTO.from_dict(obj["serviceNowAuthParams"]) if obj.get("serviceNowAuthParams") is not None else None, + "jdbcAuthParams": DesignerJdbcAuthParamsDTO.from_dict(obj["jdbcAuthParams"]) if obj.get("jdbcAuthParams") is not None else None, + "s3AuthParams": DesignerBasicS3AuthParamsDTO.from_dict(obj["s3AuthParams"]) if obj.get("s3AuthParams") is not None else None, + "internalS3AuthParams": DesignerInternalS3AuthParamsDTO.from_dict(obj["internalS3AuthParams"]) if obj.get("internalS3AuthParams") is not None else None, + "copyS3AuthParams": DesignerCopyS3AuthParamsDTO.from_dict(obj["copyS3AuthParams"]) if obj.get("copyS3AuthParams") is not None else None, + "redshiftAuthParams": DesignerRedshiftAuthParamsDTO.from_dict(obj["redshiftAuthParams"]) if obj.get("redshiftAuthParams") is not None else None, + "snowflakeAuthParams": DesignerSnowflakeAuthParamsDTO.from_dict(obj["snowflakeAuthParams"]) if obj.get("snowflakeAuthParams") is not None else None, + "bigQueryAuthParams": DesignerBigQueryAuthParamsDTO.from_dict(obj["bigQueryAuthParams"]) if obj.get("bigQueryAuthParams") is not None else None, + "sqlServerAuthParams": DesignerSqlServerAuthParamsDTO.from_dict(obj["sqlServerAuthParams"]) if obj.get("sqlServerAuthParams") is not None else None, + "dimensionsAuthParams": DesignerDimensionsAuthParamsDTO.from_dict(obj["dimensionsAuthParams"]) if obj.get("dimensionsAuthParams") is not None else None, + "willowAuthParams": DesignerWillowAuthParamsDTO.from_dict(obj["willowAuthParams"]) if obj.get("willowAuthParams") is not None else None, + "emptyAuthParams": obj.get("emptyAuthParams"), + "successFactorsAuthParams": DesignerSuccessFactorsAuthParamsDTO.from_dict(obj["successFactorsAuthParams"]) if obj.get("successFactorsAuthParams") is not None else None, + "fusionAuthParams": DesignerFusionAuthParamsDTO.from_dict(obj["fusionAuthParams"]) if obj.get("fusionAuthParams") is not None else None, + "adpAuthParams": DesignerAdpAuthParamsDTO.from_dict(obj["adpAuthParams"]) if obj.get("adpAuthParams") is not None else None, + "medalliaAuthParams": DesignerMedalliaAuthParamsDTO.from_dict(obj["medalliaAuthParams"]) if obj.get("medalliaAuthParams") is not None else None, + "salesforceV2AuthParams": DesignerSalesforceV2AuthParamsDTO.from_dict(obj["salesforceV2AuthParams"]) if obj.get("salesforceV2AuthParams") is not None else None, + "gongAuthParams": DesignerGongAuthParamsDTO.from_dict(obj["gongAuthParams"]) if obj.get("gongAuthParams") is not None else None, + "zoomAuthParams": DesignerZoomAuthParamsDTO.from_dict(obj["zoomAuthParams"]) if obj.get("zoomAuthParams") is not None else None, + "dayforceV2AuthParams": DesignerDayforceV2AuthParamsDTO.from_dict(obj["dayforceV2AuthParams"]) if obj.get("dayforceV2AuthParams") is not None else None, + "slackAuthParams": DesignerSlackAuthParamsDTO.from_dict(obj["slackAuthParams"]) if obj.get("slackAuthParams") is not None else None, + "mySqlAuthParams": DesignerMySqlAuthParamsDTO.from_dict(obj["mySqlAuthParams"]) if obj.get("mySqlAuthParams") is not None else None, + "workdayRaasAuthParams": DesignerWorkdayRaasAuthParamsDTO.from_dict(obj["workdayRaasAuthParams"]) if obj.get("workdayRaasAuthParams") is not None else None, + "ms365AuthParams": DesignerMicrosoft365AuthParamsDTO.from_dict(obj["ms365AuthParams"]) if obj.get("ms365AuthParams") is not None else None, + "googleWorkspaceAuthParams": DesignerGoogleWorkspaceAuthParamsDTO.from_dict(obj["googleWorkspaceAuthParams"]) if obj.get("googleWorkspaceAuthParams") is not None else None, + "oracleDbAuthParams": DesignerOracleDbAuthParamsDTO.from_dict(obj["oracleDbAuthParams"]) if obj.get("oracleDbAuthParams") is not None else None, + "serviceNowV2AuthParams": DesignerServiceNowV2AuthParamsDTO.from_dict(obj["serviceNowV2AuthParams"]) if obj.get("serviceNowV2AuthParams") is not None else None, + "databricksAuthParams": DesignerDatabricksAuthParamsDTO.from_dict(obj["databricksAuthParams"]) if obj.get("databricksAuthParams") is not None else None, + "hasUpdates": obj.get("hasUpdates"), + "authContext": obj.get("authContext") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_basic_information_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_basic_information_dto.py new file mode 100644 index 0000000000..7f206ea4fe --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_basic_information_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataProviderBasicInformationDTO(BaseModel): + """ + DesignerDataProviderBasicInformationDTO + """ # noqa: E501 + display_name: Optional[StrictStr] = Field(default=None, alias="displayName") + description: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["displayName", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataProviderBasicInformationDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataProviderBasicInformationDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "displayName": obj.get("displayName"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_basic_metadata_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_basic_metadata_dto.py new file mode 100644 index 0000000000..0d98d95dc8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_provider_basic_metadata_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataProviderBasicMetadataDTO(BaseModel): + """ + DesignerDataProviderBasicMetadataDTO + """ # noqa: E501 + can_children_inherit: Optional[StrictBool] = Field(default=None, alias="canChildrenInherit") + __properties: ClassVar[List[str]] = ["canChildrenInherit"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataProviderBasicMetadataDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataProviderBasicMetadataDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "canChildrenInherit": obj.get("canChildrenInherit") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_column_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_column_dto.py new file mode 100644 index 0000000000..5bad8bd311 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_column_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportColumnDTO(BaseModel): + """ + DesignerDataVersionExportColumnDTO + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The column's name.") + data_type: Optional[StrictStr] = Field(default=None, description="The column's data type. Possible data types are string, integer, number, date, Boolean.", alias="dataType") + allows_null: Optional[StrictBool] = Field(default=None, description="If `true`, the column allows null values.", alias="allowsNull") + is_primary_key_component: Optional[StrictBool] = Field(default=None, description="If `true`, the column is part of the primary key.", alias="isPrimaryKeyComponent") + __properties: ClassVar[List[str]] = ["name", "dataType", "allowsNull", "isPrimaryKeyComponent"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportColumnDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportColumnDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "dataType": obj.get("dataType"), + "allowsNull": obj.get("allowsNull"), + "isPrimaryKeyComponent": obj.get("isPrimaryKeyComponent") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_data_version_summary_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_data_version_summary_dto.py new file mode 100644 index 0000000000..719bf924f5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_data_version_summary_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportDataVersionSummaryDTO(BaseModel): + """ + DesignerDataVersionExportDataVersionSummaryDTO + """ # noqa: E501 + data_version: Optional[StrictStr] = Field(default=None, description="The data version number.", alias="dataVersion") + data_category: Optional[StrictStr] = Field(default=None, description="The data category that the data version belongs to. If empty, the data version belongs to the default data category.", alias="dataCategory") + created: Optional[StrictStr] = Field(default=None, description="The date that the data version was generated, in milliseconds since 1970-01-01T00:00:00Z.") + __properties: ClassVar[List[str]] = ["dataVersion", "dataCategory", "created"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportDataVersionSummaryDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportDataVersionSummaryDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataVersion": obj.get("dataVersion"), + "dataCategory": obj.get("dataCategory"), + "created": obj.get("created") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_data_versions_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_data_versions_dto.py new file mode 100644 index 0000000000..13a6105f26 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_data_versions_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_data_version_export_data_version_summary_dto import DesignerDataVersionExportDataVersionSummaryDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportDataVersionsDTO(BaseModel): + """ + DesignerDataVersionExportDataVersionsDTO + """ # noqa: E501 + data_versions: Optional[List[DesignerDataVersionExportDataVersionSummaryDTO]] = Field(default=None, description="All the available data versions for the tenant's primary data category.", alias="dataVersions") + __properties: ClassVar[List[str]] = ["dataVersions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportDataVersionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_versions (list) + _items = [] + if self.data_versions: + for _item_data_versions in self.data_versions: + if _item_data_versions: + _items.append(_item_data_versions.to_dict()) + _dict['dataVersions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportDataVersionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataVersions": [DesignerDataVersionExportDataVersionSummaryDTO.from_dict(_item) for _item in obj["dataVersions"]] if obj.get("dataVersions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_dto.py new file mode 100644 index 0000000000..a9c9666d7e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_dto.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_data_version_export_table_dto import DesignerDataVersionExportTableDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportDTO(BaseModel): + """ + DesignerDataVersionExportDTO + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The unique identifier of the data version export. Must be a valid UUID.") + timestamp: Optional[StrictStr] = Field(default=None, description="The date that the data version export was generated, in milliseconds since 1970-01-01T00:00:00Z.") + data_version_number: Optional[StrictStr] = Field(default=None, description="The data version number for which the export was generated.", alias="dataVersionNumber") + base_data_version_number: Optional[StrictStr] = Field(default=None, description="The baseline data version number for which the export was generated. If specified, the export is a delta of the differences between `dateVersionNumber` and `baseDataVersionNumber`. If empty, a full export is generated for `dataVersionNumber`.", alias="baseDataVersionNumber") + tables: Optional[List[DesignerDataVersionExportTableDTO]] = Field(default=None, description="Information about the tables in the export.") + new_tables: Optional[List[StrictStr]] = Field(default=None, description="Tables that exist in `dataVersionNumber` but did not exist in `baseDataVersionNumber`.", alias="newTables") + deleted_tables: Optional[List[StrictStr]] = Field(default=None, description="Tables that do not exist in `dataVersionNumber` but did exist in `baseDataVersionNumber`.", alias="deletedTables") + __properties: ClassVar[List[str]] = ["uuid", "timestamp", "dataVersionNumber", "baseDataVersionNumber", "tables", "newTables", "deletedTables"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tables (list) + _items = [] + if self.tables: + for _item_tables in self.tables: + if _item_tables: + _items.append(_item_tables.to_dict()) + _dict['tables'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "timestamp": obj.get("timestamp"), + "dataVersionNumber": obj.get("dataVersionNumber"), + "baseDataVersionNumber": obj.get("baseDataVersionNumber"), + "tables": [DesignerDataVersionExportTableDTO.from_dict(_item) for _item in obj["tables"]] if obj.get("tables") is not None else None, + "newTables": obj.get("newTables"), + "deletedTables": obj.get("deletedTables") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_file_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_file_dto.py new file mode 100644 index 0000000000..e6a710e4b1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_file_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_data_version_export_column_dto import DesignerDataVersionExportColumnDTO +from visier_platform_sdk.models.designer_data_version_export_part_file_dto import DesignerDataVersionExportPartFileDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportFileDTO(BaseModel): + """ + DesignerDataVersionExportFileDTO + """ # noqa: E501 + columns: Optional[List[DesignerDataVersionExportColumnDTO]] = Field(default=None, description="Information about a table's columns.") + files: Optional[List[DesignerDataVersionExportPartFileDTO]] = Field(default=None, description="Information about a table's files in the export.") + __properties: ClassVar[List[str]] = ["columns", "files"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportFileDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in columns (list) + _items = [] + if self.columns: + for _item_columns in self.columns: + if _item_columns: + _items.append(_item_columns.to_dict()) + _dict['columns'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in files (list) + _items = [] + if self.files: + for _item_files in self.files: + if _item_files: + _items.append(_item_files.to_dict()) + _dict['files'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportFileDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columns": [DesignerDataVersionExportColumnDTO.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None, + "files": [DesignerDataVersionExportPartFileDTO.from_dict(_item) for _item in obj["files"]] if obj.get("files") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_job_status_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_job_status_dto.py new file mode 100644 index 0000000000..2fb6937f25 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_job_status_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportJobStatusDTO(BaseModel): + """ + DesignerDataVersionExportJobStatusDTO + """ # noqa: E501 + job_uuid: Optional[StrictStr] = Field(default=None, description="The unique identifier of the data version export job.", alias="jobUuid") + completed: Optional[StrictBool] = Field(default=None, description="If `true`, the job completed successfully.") + failed: Optional[StrictBool] = Field(default=None, description="If `true`, the job failed.") + export_uuid: Optional[StrictStr] = Field(default=None, description="The unique identifier of the data version export generated by the job. If empty, the job hasn't completed successfully.", alias="exportUuid") + __properties: ClassVar[List[str]] = ["jobUuid", "completed", "failed", "exportUuid"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportJobStatusDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportJobStatusDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobUuid": obj.get("jobUuid"), + "completed": obj.get("completed"), + "failed": obj.get("failed"), + "exportUuid": obj.get("exportUuid") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_part_file_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_part_file_dto.py new file mode 100644 index 0000000000..b2205ca6b3 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_part_file_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportPartFileDTO(BaseModel): + """ + DesignerDataVersionExportPartFileDTO + """ # noqa: E501 + file_id: Optional[StrictInt] = Field(default=None, description="The unique integer identifier of the file in the data version export.", alias="fileId") + filename: Optional[StrictStr] = Field(default=None, description="The file's name.") + __properties: ClassVar[List[str]] = ["fileId", "filename"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportPartFileDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportPartFileDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fileId": obj.get("fileId"), + "filename": obj.get("filename") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_schedule_job_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_schedule_job_request_dto.py new file mode 100644 index 0000000000..dd5d773978 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_schedule_job_request_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportScheduleJobRequestDTO(BaseModel): + """ + DesignerDataVersionExportScheduleJobRequestDTO + """ # noqa: E501 + data_version_number: Optional[StrictStr] = Field(default=None, description="The data version number to generate an export for.", alias="dataVersionNumber") + base_data_version_number: Optional[StrictStr] = Field(default=None, description="Optional. The baseline data version number to use to generate a delta export. Delta exports contain the differences between `baseDataVersionNumber` and `dataVersionNumber`, such as anything updated, added, or removed in `dataVersionNumber`. If `baseDataVersionNumber` is not provided, a full export generates for `dataVersionNumber`.", alias="baseDataVersionNumber") + __properties: ClassVar[List[str]] = ["dataVersionNumber", "baseDataVersionNumber"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportScheduleJobRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportScheduleJobRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataVersionNumber": obj.get("dataVersionNumber"), + "baseDataVersionNumber": obj.get("baseDataVersionNumber") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_schedule_job_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_schedule_job_response_dto.py new file mode 100644 index 0000000000..7d8ac96870 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_schedule_job_response_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportScheduleJobResponseDTO(BaseModel): + """ + DesignerDataVersionExportScheduleJobResponseDTO + """ # noqa: E501 + job_uuid: Optional[StrictStr] = Field(default=None, description="The unique identifier of the scheduled data version export job.", alias="jobUuid") + __properties: ClassVar[List[str]] = ["jobUuid"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportScheduleJobResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportScheduleJobResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobUuid": obj.get("jobUuid") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_table_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_table_dto.py new file mode 100644 index 0000000000..1a6030918a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_export_table_dto.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_data_version_export_file_dto import DesignerDataVersionExportFileDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportTableDTO(BaseModel): + """ + DesignerDataVersionExportTableDTO + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The name of a table in the data version export; for example, Employee or Applicant.") + common_columns: Optional[DesignerDataVersionExportFileDTO] = Field(default=None, description="Information about the columns and files that are in both `dataVersionNumber` and `baseDataVersionNumber`. Always empty for full exports where `baseDataVersionNumber` is not specified.", alias="commonColumns") + new_columns: Optional[DesignerDataVersionExportFileDTO] = Field(default=None, description="Information about new columns and files in the data version. If full export, lists all columns. If delta export, lists columns that exist in `dataVersionNumber` but not in `baseDataVersionNumber`.", alias="newColumns") + deleted_columns: Optional[List[StrictStr]] = Field(default=None, description="Information about columns that do not exist in `dataVersionNumber` but did exist in `baseDataVersionNumber`.", alias="deletedColumns") + __properties: ClassVar[List[str]] = ["name", "commonColumns", "newColumns", "deletedColumns"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportTableDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of common_columns + if self.common_columns: + _dict['commonColumns'] = self.common_columns.to_dict() + # override the default output from pydantic by calling `to_dict()` of new_columns + if self.new_columns: + _dict['newColumns'] = self.new_columns.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportTableDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "commonColumns": DesignerDataVersionExportFileDTO.from_dict(obj["commonColumns"]) if obj.get("commonColumns") is not None else None, + "newColumns": DesignerDataVersionExportFileDTO.from_dict(obj["newColumns"]) if obj.get("newColumns") is not None else None, + "deletedColumns": obj.get("deletedColumns") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_exports_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_exports_dto.py new file mode 100644 index 0000000000..4d205253a6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_data_version_exports_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_data_version_export_dto import DesignerDataVersionExportDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDataVersionExportsDTO(BaseModel): + """ + DesignerDataVersionExportsDTO + """ # noqa: E501 + data_version_exports: Optional[List[DesignerDataVersionExportDTO]] = Field(default=None, description="Information about data version exports.", alias="dataVersionExports") + __properties: ClassVar[List[str]] = ["dataVersionExports"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_version_exports (list) + _items = [] + if self.data_version_exports: + for _item_data_version_exports in self.data_version_exports: + if _item_data_version_exports: + _items.append(_item_data_version_exports.to_dict()) + _dict['dataVersionExports'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDataVersionExportsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataVersionExports": [DesignerDataVersionExportDTO.from_dict(_item) for _item in obj["dataVersionExports"]] if obj.get("dataVersionExports") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_databricks_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_databricks_auth_params_dto.py new file mode 100644 index 0000000000..4783355c0d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_databricks_auth_params_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDatabricksAuthParamsDTO(BaseModel): + """ + DesignerDatabricksAuthParamsDTO + """ # noqa: E501 + share_credentials_version: Optional[StrictStr] = Field(default=None, alias="shareCredentialsVersion") + bearer_token: Optional[StrictStr] = Field(default=None, alias="bearerToken") + endpoint: Optional[StrictStr] = None + expiration_time: Optional[StrictStr] = Field(default=None, alias="expirationTime") + __properties: ClassVar[List[str]] = ["shareCredentialsVersion", "bearerToken", "endpoint", "expirationTime"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDatabricksAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDatabricksAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "shareCredentialsVersion": obj.get("shareCredentialsVersion"), + "bearerToken": obj.get("bearerToken"), + "endpoint": obj.get("endpoint"), + "expirationTime": obj.get("expirationTime") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_dayforce_v2_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_dayforce_v2_auth_params_dto.py new file mode 100644 index 0000000000..527da93644 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_dayforce_v2_auth_params_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDayforceV2AuthParamsDTO(BaseModel): + """ + DesignerDayforceV2AuthParamsDTO + """ # noqa: E501 + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + company_id: Optional[StrictStr] = Field(default=None, alias="companyId") + token_host: Optional[StrictStr] = Field(default=None, alias="tokenHost") + host_domain_name: Optional[StrictStr] = Field(default=None, alias="hostDomainName") + __properties: ClassVar[List[str]] = ["username", "password", "companyId", "tokenHost", "hostDomainName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDayforceV2AuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDayforceV2AuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "username": obj.get("username"), + "password": obj.get("password"), + "companyId": obj.get("companyId"), + "tokenHost": obj.get("tokenHost"), + "hostDomainName": obj.get("hostDomainName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_dimensions_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_dimensions_auth_params_dto.py new file mode 100644 index 0000000000..7fa5c9a74c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_dimensions_auth_params_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDimensionsAuthParamsDTO(BaseModel): + """ + DesignerDimensionsAuthParamsDTO + """ # noqa: E501 + app_key: Optional[StrictStr] = Field(default=None, alias="appKey") + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + vanity_url: Optional[StrictStr] = Field(default=None, alias="vanityUrl") + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["appKey", "clientId", "clientSecret", "vanityUrl", "username", "password"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDimensionsAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDimensionsAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "appKey": obj.get("appKey"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "vanityUrl": obj.get("vanityUrl"), + "username": obj.get("username"), + "password": obj.get("password") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_download_source_files_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_download_source_files_dto.py new file mode 100644 index 0000000000..650ce29e89 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_download_source_files_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDownloadSourceFilesDTO(BaseModel): + """ + DesignerDownloadSourceFilesDTO + """ # noqa: E501 + download_all: Optional[StrictBool] = Field(default=None, description="If `true`, downloads all uploaded files for all sources. Default is `false`.", alias="downloadAll") + sources: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings representing the object name of each source to download.") + source_ids: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings representing the unique identifier of each source to download.", alias="sourceIds") + min_timestamp: Optional[StrictStr] = Field(default=None, description="The earliest upload time to download files from in ISO 8601 format, such as `\"2001-10-25T13:45:35.999\"`. If omitted, downloads files from the earliest available time.", alias="minTimestamp") + max_timestamp: Optional[StrictStr] = Field(default=None, description="The latest upload time to download files up to in ISO 8601 format, such as `\"2001-10-25T13:45:35.999\"`. If omitted, downloads files up to the latest available time.", alias="maxTimestamp") + min_snapshot_timestamp: Optional[StrictStr] = Field(default=None, description="The earliest snapshot time to download files from in ISO 8601 format, such as `\"2001-10-25T13:45:35.999\"`. If omitted, downloads files from the earliest available time.", alias="minSnapshotTimestamp") + max_snapshot_timestamp: Optional[StrictStr] = Field(default=None, description="The latest snapshot time to download files up to in ISO 8601 format, such as `\"2001-10-25T13:45:35.999\"`. If omitted, downloads files up to the latest available time.", alias="maxSnapshotTimestamp") + include_non_active_files: Optional[StrictBool] = Field(default=None, description="If `true`, includes excluded files in download. Default is `false`.", alias="includeNonActiveFiles") + __properties: ClassVar[List[str]] = ["downloadAll", "sources", "sourceIds", "minTimestamp", "maxTimestamp", "minSnapshotTimestamp", "maxSnapshotTimestamp", "includeNonActiveFiles"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDownloadSourceFilesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDownloadSourceFilesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "downloadAll": obj.get("downloadAll"), + "sources": obj.get("sources"), + "sourceIds": obj.get("sourceIds"), + "minTimestamp": obj.get("minTimestamp"), + "maxTimestamp": obj.get("maxTimestamp"), + "minSnapshotTimestamp": obj.get("minSnapshotTimestamp"), + "maxSnapshotTimestamp": obj.get("maxSnapshotTimestamp"), + "includeNonActiveFiles": obj.get("includeNonActiveFiles") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_download_source_files_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_download_source_files_response_dto.py new file mode 100644 index 0000000000..51c594c378 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_download_source_files_response_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerDownloadSourceFilesResponseDTO(BaseModel): + """ + DesignerDownloadSourceFilesResponseDTO + """ # noqa: E501 + status: Optional[StrictStr] = Field(default=None, description="The download request status, such as `Error`.") + messages: Optional[StrictStr] = Field(default=None, description="A description of the request status.") + __properties: ClassVar[List[str]] = ["status", "messages"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerDownloadSourceFilesResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerDownloadSourceFilesResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "status": obj.get("status"), + "messages": obj.get("messages") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_extractor_credential_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_extractor_credential_apidto.py new file mode 100644 index 0000000000..2deb5e7e96 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_extractor_credential_apidto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerExtractorCredentialAPIDTO(BaseModel): + """ + DesignerExtractorCredentialAPIDTO + """ # noqa: E501 + credential_id: Optional[StrictStr] = Field(default=None, description="The ID associated with the connector credential.", alias="credentialId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable connector credential name that is displayed within Visier.", alias="displayName") + data_provider: Optional[StrictStr] = Field(default=None, description="The data provider associated with the credential.", alias="dataProvider") + is_inherited: Optional[StrictBool] = Field(default=None, description="Whether this credential is inherited from another tenant.", alias="isInherited") + auth_context: Optional[StrictStr] = Field(default=None, alias="authContext") + __properties: ClassVar[List[str]] = ["credentialId", "displayName", "dataProvider", "isInherited", "authContext"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerExtractorCredentialAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerExtractorCredentialAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "credentialId": obj.get("credentialId"), + "displayName": obj.get("displayName"), + "dataProvider": obj.get("dataProvider"), + "isInherited": obj.get("isInherited"), + "authContext": obj.get("authContext") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_extractor_credentials_apidto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_extractor_credentials_apidto.py new file mode 100644 index 0000000000..2c2c398c08 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_extractor_credentials_apidto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_extractor_credential_apidto import DesignerExtractorCredentialAPIDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerExtractorCredentialsAPIDTO(BaseModel): + """ + DesignerExtractorCredentialsAPIDTO + """ # noqa: E501 + connector_credentials: Optional[List[DesignerExtractorCredentialAPIDTO]] = Field(default=None, description="A list of objects representing all the available connector credentials in Production.", alias="connectorCredentials") + limit: Optional[StrictInt] = Field(default=None, description="The number of connector credentials to return. The maximum number of data connector credentials to return is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving values from, also known as offset. The index begins at 0.") + __properties: ClassVar[List[str]] = ["connectorCredentials", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerExtractorCredentialsAPIDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in connector_credentials (list) + _items = [] + if self.connector_credentials: + for _item_connector_credentials in self.connector_credentials: + if _item_connector_credentials: + _items.append(_item_connector_credentials.to_dict()) + _dict['connectorCredentials'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerExtractorCredentialsAPIDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "connectorCredentials": [DesignerExtractorCredentialAPIDTO.from_dict(_item) for _item in obj["connectorCredentials"]] if obj.get("connectorCredentials") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_fusion_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_fusion_auth_params_dto.py new file mode 100644 index 0000000000..f121455a8f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_fusion_auth_params_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerFusionAuthParamsDTO(BaseModel): + """ + DesignerFusionAuthParamsDTO + """ # noqa: E501 + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + host_domain_name: Optional[StrictStr] = Field(default=None, alias="hostDomainName") + __properties: ClassVar[List[str]] = ["username", "password", "hostDomainName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerFusionAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerFusionAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "username": obj.get("username"), + "password": obj.get("password"), + "hostDomainName": obj.get("hostDomainName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_gong_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_gong_auth_params_dto.py new file mode 100644 index 0000000000..982b54871c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_gong_auth_params_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerGongAuthParamsDTO(BaseModel): + """ + DesignerGongAuthParamsDTO + """ # noqa: E501 + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + __properties: ClassVar[List[str]] = ["clientId", "clientSecret"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerGongAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerGongAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_google_sheets_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_google_sheets_auth_params_dto.py new file mode 100644 index 0000000000..2b9caff038 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_google_sheets_auth_params_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerGoogleSheetsAuthParamsDTO(BaseModel): + """ + DesignerGoogleSheetsAuthParamsDTO + """ # noqa: E501 + auth_code: Optional[StrictStr] = Field(default=None, alias="authCode") + configuration: Optional[StrictStr] = None + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + __properties: ClassVar[List[str]] = ["authCode", "configuration", "clientId", "clientSecret"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerGoogleSheetsAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerGoogleSheetsAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authCode": obj.get("authCode"), + "configuration": obj.get("configuration"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_google_workspace_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_google_workspace_auth_params_dto.py new file mode 100644 index 0000000000..9fc94c045f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_google_workspace_auth_params_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerGoogleWorkspaceAuthParamsDTO(BaseModel): + """ + DesignerGoogleWorkspaceAuthParamsDTO + """ # noqa: E501 + auth_code: Optional[StrictStr] = Field(default=None, alias="authCode") + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + service_account: Optional[StrictStr] = Field(default=None, alias="serviceAccount") + privacy_mode: Optional[StrictStr] = Field(default=None, alias="privacyMode") + __properties: ClassVar[List[str]] = ["authCode", "clientId", "clientSecret", "serviceAccount", "privacyMode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerGoogleWorkspaceAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerGoogleWorkspaceAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authCode": obj.get("authCode"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "serviceAccount": obj.get("serviceAccount"), + "privacyMode": obj.get("privacyMode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_greenhouse_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_greenhouse_auth_params_dto.py new file mode 100644 index 0000000000..30348d83e6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_greenhouse_auth_params_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerGreenhouseAuthParamsDTO(BaseModel): + """ + DesignerGreenhouseAuthParamsDTO + """ # noqa: E501 + api_key: Optional[StrictStr] = Field(default=None, alias="apiKey") + __properties: ClassVar[List[str]] = ["apiKey"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerGreenhouseAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerGreenhouseAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "apiKey": obj.get("apiKey") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_icims_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_icims_auth_params_dto.py new file mode 100644 index 0000000000..4777a20ecb --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_icims_auth_params_dto.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerIcimsAuthParamsDTO(BaseModel): + """ + DesignerIcimsAuthParamsDTO + """ # noqa: E501 + customer_id: Optional[StrictStr] = Field(default=None, alias="customerId") + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + region: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["customerId", "username", "password", "clientId", "clientSecret", "region"] + + @field_validator('region') + def region_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['US', 'EU', 'CA', 'ISV']): + raise ValueError("must be one of enum values ('US', 'EU', 'CA', 'ISV')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerIcimsAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerIcimsAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "customerId": obj.get("customerId"), + "username": obj.get("username"), + "password": obj.get("password"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "region": obj.get("region") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_internal_s3_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_internal_s3_auth_params_dto.py new file mode 100644 index 0000000000..ace8c23022 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_internal_s3_auth_params_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerInternalS3AuthParamsDTO(BaseModel): + """ + DesignerInternalS3AuthParamsDTO + """ # noqa: E501 + bucket_name: Optional[StrictStr] = Field(default=None, alias="bucketName") + path: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["bucketName", "path"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerInternalS3AuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerInternalS3AuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "bucketName": obj.get("bucketName"), + "path": obj.get("path") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_jdbc_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_jdbc_auth_params_dto.py new file mode 100644 index 0000000000..035fbba580 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_jdbc_auth_params_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerJdbcAuthParamsDTO(BaseModel): + """ + DesignerJdbcAuthParamsDTO + """ # noqa: E501 + jdbc_connect_string: Optional[StrictStr] = Field(default=None, alias="jdbcConnectString") + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["jdbcConnectString", "username", "password"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerJdbcAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerJdbcAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jdbcConnectString": obj.get("jdbcConnectString"), + "username": obj.get("username"), + "password": obj.get("password") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_jira_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_jira_auth_params_dto.py new file mode 100644 index 0000000000..9dc226a084 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_jira_auth_params_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_jira_connect_params_dto import DesignerJiraConnectParamsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerJiraAuthParamsDTO(BaseModel): + """ + DesignerJiraAuthParamsDTO + """ # noqa: E501 + api_token: Optional[StrictStr] = Field(default=None, alias="apiToken") + host_name: Optional[StrictStr] = Field(default=None, alias="hostName") + connect_params: Optional[DesignerJiraConnectParamsDTO] = Field(default=None, alias="connectParams") + __properties: ClassVar[List[str]] = ["apiToken", "hostName", "connectParams"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerJiraAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of connect_params + if self.connect_params: + _dict['connectParams'] = self.connect_params.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerJiraAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "apiToken": obj.get("apiToken"), + "hostName": obj.get("hostName"), + "connectParams": DesignerJiraConnectParamsDTO.from_dict(obj["connectParams"]) if obj.get("connectParams") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_jira_connect_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_jira_connect_params_dto.py new file mode 100644 index 0000000000..6f44230671 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_jira_connect_params_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerJiraConnectParamsDTO(BaseModel): + """ + DesignerJiraConnectParamsDTO + """ # noqa: E501 + app_key: Optional[StrictStr] = Field(default=None, alias="appKey") + client_key: Optional[StrictStr] = Field(default=None, alias="clientKey") + shared_secret: Optional[StrictStr] = Field(default=None, alias="sharedSecret") + __properties: ClassVar[List[str]] = ["appKey", "clientKey", "sharedSecret"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerJiraConnectParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerJiraConnectParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "appKey": obj.get("appKey"), + "clientKey": obj.get("clientKey"), + "sharedSecret": obj.get("sharedSecret") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_lever_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_lever_auth_params_dto.py new file mode 100644 index 0000000000..514c18a482 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_lever_auth_params_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerLeverAuthParamsDTO(BaseModel): + """ + DesignerLeverAuthParamsDTO + """ # noqa: E501 + api_key: Optional[StrictStr] = Field(default=None, alias="apiKey") + __properties: ClassVar[List[str]] = ["apiKey"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerLeverAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerLeverAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "apiKey": obj.get("apiKey") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_medallia_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_medallia_auth_params_dto.py new file mode 100644 index 0000000000..fe3df88eef --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_medallia_auth_params_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerMedalliaAuthParamsDTO(BaseModel): + """ + DesignerMedalliaAuthParamsDTO + """ # noqa: E501 + tenant_domain_name: Optional[StrictStr] = Field(default=None, alias="tenantDomainName") + instance_url: Optional[StrictStr] = Field(default=None, alias="instanceUrl") + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + __properties: ClassVar[List[str]] = ["tenantDomainName", "instanceUrl", "clientId", "clientSecret"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerMedalliaAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerMedalliaAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantDomainName": obj.get("tenantDomainName"), + "instanceUrl": obj.get("instanceUrl"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_microsoft365_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_microsoft365_auth_params_dto.py new file mode 100644 index 0000000000..435b22f236 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_microsoft365_auth_params_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerMicrosoft365AuthParamsDTO(BaseModel): + """ + DesignerMicrosoft365AuthParamsDTO + """ # noqa: E501 + o_auth_tenant_id: Optional[StrictStr] = Field(default=None, alias="oAuthTenantId") + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + privacy_mode: Optional[StrictStr] = Field(default=None, alias="privacyMode") + __properties: ClassVar[List[str]] = ["oAuthTenantId", "clientId", "clientSecret", "privacyMode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerMicrosoft365AuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerMicrosoft365AuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "oAuthTenantId": obj.get("oAuthTenantId"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "privacyMode": obj.get("privacyMode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_module_settings_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_module_settings_dto.py new file mode 100644 index 0000000000..54d0c1973f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_module_settings_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerModuleSettingsDTO(BaseModel): + """ + DesignerModuleSettingsDTO + """ # noqa: E501 + unavailable_for_assignment: Optional[StrictBool] = Field(default=None, description="If true, the module cannot be assigned to tenants.", alias="unavailableForAssignment") + special_handling_instruction: Optional[StrictStr] = Field(default=None, description="An instruction message in the module selection dialog. This can be a note for administrators such as \"Don't assign this module\" or \"Assign Module B instead\".", alias="specialHandlingInstruction") + locale: Optional[StrictStr] = Field(default=None, description="The language of the module. For example, a module that is in English will have the locale \"en\".") + __properties: ClassVar[List[str]] = ["unavailableForAssignment", "specialHandlingInstruction", "locale"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerModuleSettingsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerModuleSettingsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "unavailableForAssignment": obj.get("unavailableForAssignment"), + "specialHandlingInstruction": obj.get("specialHandlingInstruction"), + "locale": obj.get("locale") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_my_sql_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_my_sql_auth_params_dto.py new file mode 100644 index 0000000000..63f936cbec --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_my_sql_auth_params_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerMySqlAuthParamsDTO(BaseModel): + """ + DesignerMySqlAuthParamsDTO + """ # noqa: E501 + host: Optional[StrictStr] = None + port: Optional[StrictStr] = None + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + database: Optional[StrictStr] = None + ssl_mode: Optional[StrictStr] = Field(default=None, alias="sslMode") + __properties: ClassVar[List[str]] = ["host", "port", "username", "password", "database", "sslMode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerMySqlAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerMySqlAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "host": obj.get("host"), + "port": obj.get("port"), + "username": obj.get("username"), + "password": obj.get("password"), + "database": obj.get("database"), + "sslMode": obj.get("sslMode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_namely_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_namely_auth_params_dto.py new file mode 100644 index 0000000000..eb8795d770 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_namely_auth_params_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerNamelyAuthParamsDTO(BaseModel): + """ + DesignerNamelyAuthParamsDTO + """ # noqa: E501 + auth_code: Optional[StrictStr] = Field(default=None, alias="authCode") + __properties: ClassVar[List[str]] = ["authCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerNamelyAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerNamelyAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authCode": obj.get("authCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_oracle_db_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_oracle_db_auth_params_dto.py new file mode 100644 index 0000000000..9dfcbce194 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_oracle_db_auth_params_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerOracleDbAuthParamsDTO(BaseModel): + """ + DesignerOracleDbAuthParamsDTO + """ # noqa: E501 + host: Optional[StrictStr] = None + port: Optional[StrictStr] = None + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + service_name: Optional[StrictStr] = Field(default=None, alias="serviceName") + __properties: ClassVar[List[str]] = ["host", "port", "username", "password", "serviceName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerOracleDbAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerOracleDbAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "host": obj.get("host"), + "port": obj.get("port"), + "username": obj.get("username"), + "password": obj.get("password"), + "serviceName": obj.get("serviceName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_push_data_column_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_push_data_column_definition_dto.py new file mode 100644 index 0000000000..95b073abb4 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_push_data_column_definition_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerPushDataColumnDefinitionDTO(BaseModel): + """ + Definition of the source column. + """ # noqa: E501 + column_name: Optional[StrictStr] = Field(default=None, description="The name of the column.", alias="columnName") + data_type: Optional[StrictStr] = Field(default=None, description="The data type associated with the column.", alias="dataType") + data_formats: Optional[List[StrictStr]] = Field(default=None, description="The expected format for datetime data types.", alias="dataFormats") + is_mandatory: Optional[StrictBool] = Field(default=None, description="If true, the column value is required. If a column is mandatory, and the file is missing this column, the request will fail.", alias="isMandatory") + allow_empty: Optional[StrictBool] = Field(default=None, description="If true, the column allows an empty value for the record.", alias="allowEmpty") + default_value: Optional[StrictStr] = Field(default=None, description="The default value of the column.", alias="defaultValue") + __properties: ClassVar[List[str]] = ["columnName", "dataType", "dataFormats", "isMandatory", "allowEmpty", "defaultValue"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerPushDataColumnDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerPushDataColumnDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "columnName": obj.get("columnName"), + "dataType": obj.get("dataType"), + "dataFormats": obj.get("dataFormats"), + "isMandatory": obj.get("isMandatory"), + "allowEmpty": obj.get("allowEmpty"), + "defaultValue": obj.get("defaultValue") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_push_data_source_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_push_data_source_definition_dto.py new file mode 100644 index 0000000000..2646379fdb --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_push_data_source_definition_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_push_data_column_definition_dto import DesignerPushDataColumnDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerPushDataSourceDefinitionDTO(BaseModel): + """ + Details of each existing source. + """ # noqa: E501 + source_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the source.", alias="sourceId") + name: Optional[StrictStr] = Field(default=None, description="The object name of the source.") + columns: Optional[List[DesignerPushDataColumnDefinitionDTO]] = Field(default=None, description="A list of objects representing the source columns.") + is_inherited: Optional[StrictBool] = Field(default=None, description="If true, the source is inherited by all analytic tenants.", alias="isInherited") + __properties: ClassVar[List[str]] = ["sourceId", "name", "columns", "isInherited"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerPushDataSourceDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in columns (list) + _items = [] + if self.columns: + for _item_columns in self.columns: + if _item_columns: + _items.append(_item_columns.to_dict()) + _dict['columns'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerPushDataSourceDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sourceId": obj.get("sourceId"), + "name": obj.get("name"), + "columns": [DesignerPushDataColumnDefinitionDTO.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None, + "isInherited": obj.get("isInherited") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_push_data_source_definitions_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_push_data_source_definitions_dto.py new file mode 100644 index 0000000000..ea95f7cc8d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_push_data_source_definitions_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_push_data_source_definition_dto import DesignerPushDataSourceDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerPushDataSourceDefinitionsDTO(BaseModel): + """ + The existing sources. + """ # noqa: E501 + sources: Optional[List[DesignerPushDataSourceDefinitionDTO]] = Field(default=None, description="A list of objects representing the target sources for the request.") + __properties: ClassVar[List[str]] = ["sources"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerPushDataSourceDefinitionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in sources (list) + _items = [] + if self.sources: + for _item_sources in self.sources: + if _item_sources: + _items.append(_item_sources.to_dict()) + _dict['sources'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerPushDataSourceDefinitionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sources": [DesignerPushDataSourceDefinitionDTO.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_qualtrics_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_qualtrics_auth_params_dto.py new file mode 100644 index 0000000000..92057fd5d0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_qualtrics_auth_params_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerQualtricsAuthParamsDTO(BaseModel): + """ + DesignerQualtricsAuthParamsDTO + """ # noqa: E501 + api_token: Optional[StrictStr] = Field(default=None, alias="apiToken") + data_center_id: Optional[StrictStr] = Field(default=None, alias="dataCenterId") + __properties: ClassVar[List[str]] = ["apiToken", "dataCenterId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerQualtricsAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerQualtricsAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "apiToken": obj.get("apiToken"), + "dataCenterId": obj.get("dataCenterId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_redshift_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_redshift_auth_params_dto.py new file mode 100644 index 0000000000..46f7671bbb --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_redshift_auth_params_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerRedshiftAuthParamsDTO(BaseModel): + """ + DesignerRedshiftAuthParamsDTO + """ # noqa: E501 + endpoint: Optional[StrictStr] = None + port: Optional[StrictStr] = None + database: Optional[StrictStr] = None + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + table_prefix: Optional[StrictStr] = Field(default=None, alias="tablePrefix") + var_schema: Optional[StrictStr] = Field(default=None, alias="schema") + __properties: ClassVar[List[str]] = ["endpoint", "port", "database", "username", "password", "tablePrefix", "schema"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerRedshiftAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerRedshiftAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "endpoint": obj.get("endpoint"), + "port": obj.get("port"), + "database": obj.get("database"), + "username": obj.get("username"), + "password": obj.get("password"), + "tablePrefix": obj.get("tablePrefix"), + "schema": obj.get("schema") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_salesforce_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_salesforce_auth_params_dto.py new file mode 100644 index 0000000000..7d608eb882 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_salesforce_auth_params_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerSalesforceAuthParamsDTO(BaseModel): + """ + DesignerSalesforceAuthParamsDTO + """ # noqa: E501 + refresh_token: Optional[StrictStr] = Field(default=None, alias="refreshToken") + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + __properties: ClassVar[List[str]] = ["refreshToken", "clientId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerSalesforceAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerSalesforceAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "refreshToken": obj.get("refreshToken"), + "clientId": obj.get("clientId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_salesforce_v2_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_salesforce_v2_auth_params_dto.py new file mode 100644 index 0000000000..e6c4a69e54 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_salesforce_v2_auth_params_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerSalesforceV2AuthParamsDTO(BaseModel): + """ + DesignerSalesforceV2AuthParamsDTO + """ # noqa: E501 + auth_code: Optional[StrictStr] = Field(default=None, alias="authCode") + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + login_host: Optional[StrictStr] = Field(default=None, alias="loginHost") + __properties: ClassVar[List[str]] = ["authCode", "clientId", "clientSecret", "loginHost"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerSalesforceV2AuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerSalesforceV2AuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authCode": obj.get("authCode"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "loginHost": obj.get("loginHost") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_service_now_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_service_now_auth_params_dto.py new file mode 100644 index 0000000000..c406ee2c89 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_service_now_auth_params_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerServiceNowAuthParamsDTO(BaseModel): + """ + DesignerServiceNowAuthParamsDTO + """ # noqa: E501 + host_domain_name: Optional[StrictStr] = Field(default=None, alias="hostDomainName") + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["hostDomainName", "username", "password"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerServiceNowAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerServiceNowAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hostDomainName": obj.get("hostDomainName"), + "username": obj.get("username"), + "password": obj.get("password") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_service_now_v2_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_service_now_v2_auth_params_dto.py new file mode 100644 index 0000000000..7bef1c65a0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_service_now_v2_auth_params_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerServiceNowV2AuthParamsDTO(BaseModel): + """ + DesignerServiceNowV2AuthParamsDTO + """ # noqa: E501 + host_domain_name: Optional[StrictStr] = Field(default=None, alias="hostDomainName") + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + auth_code: Optional[StrictStr] = Field(default=None, alias="authCode") + alternate_domain: Optional[StrictStr] = Field(default=None, alias="alternateDomain") + __properties: ClassVar[List[str]] = ["hostDomainName", "clientId", "clientSecret", "authCode", "alternateDomain"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerServiceNowV2AuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerServiceNowV2AuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hostDomainName": obj.get("hostDomainName"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret"), + "authCode": obj.get("authCode"), + "alternateDomain": obj.get("alternateDomain") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_slack_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_slack_auth_params_dto.py new file mode 100644 index 0000000000..aa60b6c836 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_slack_auth_params_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerSlackAuthParamsDTO(BaseModel): + """ + DesignerSlackAuthParamsDTO + """ # noqa: E501 + auth_code: Optional[StrictStr] = Field(default=None, alias="authCode") + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + __properties: ClassVar[List[str]] = ["authCode", "clientId", "clientSecret"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerSlackAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerSlackAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authCode": obj.get("authCode"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_snowflake_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_snowflake_auth_params_dto.py new file mode 100644 index 0000000000..41915ebee4 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_snowflake_auth_params_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerSnowflakeAuthParamsDTO(BaseModel): + """ + DesignerSnowflakeAuthParamsDTO + """ # noqa: E501 + account_identifier: Optional[StrictStr] = Field(default=None, alias="accountIdentifier") + database: Optional[StrictStr] = None + var_schema: Optional[StrictStr] = Field(default=None, alias="schema") + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + warehouse: Optional[StrictStr] = None + private_key: Optional[StrictStr] = Field(default=None, alias="privateKey") + __properties: ClassVar[List[str]] = ["accountIdentifier", "database", "schema", "username", "password", "warehouse", "privateKey"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerSnowflakeAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerSnowflakeAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "accountIdentifier": obj.get("accountIdentifier"), + "database": obj.get("database"), + "schema": obj.get("schema"), + "username": obj.get("username"), + "password": obj.get("password"), + "warehouse": obj.get("warehouse"), + "privateKey": obj.get("privateKey") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_sql_server_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_sql_server_auth_params_dto.py new file mode 100644 index 0000000000..9360e5b5f0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_sql_server_auth_params_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerSqlServerAuthParamsDTO(BaseModel): + """ + DesignerSqlServerAuthParamsDTO + """ # noqa: E501 + host: Optional[StrictStr] = None + port: Optional[StrictStr] = None + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + database: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["host", "port", "username", "password", "database"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerSqlServerAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerSqlServerAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "host": obj.get("host"), + "port": obj.get("port"), + "username": obj.get("username"), + "password": obj.get("password"), + "database": obj.get("database") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_subject_missing_access_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_subject_missing_access_dto.py new file mode 100644 index 0000000000..4f28748625 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_subject_missing_access_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerSubjectMissingAccessDTO(BaseModel): + """ + DesignerSubjectMissingAccessDTO + """ # noqa: E501 + subject: Optional[StrictStr] = Field(default=None, description="The subjects that cannot be accessed.") + attributes: Optional[List[StrictStr]] = Field(default=None, description="The attributes that cannot be accessed.") + error_message: Optional[StrictStr] = Field(default=None, description="The error message detailing the access issue.", alias="errorMessage") + __properties: ClassVar[List[str]] = ["subject", "attributes", "errorMessage"] + + @field_validator('subject') + def subject_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Employee', 'Employee_Budgeted_Compensation', 'Employment_Start', 'Employment_Exit', 'Absenteeism', 'Supervisory', 'Organization', 'Compensation_Payout', 'CustomSubject', 'TestConnectionSubject', 'Internal_Placement', 'Pay_Change', 'Hire', 'Applicant', 'Candidate', 'Requisition']): + raise ValueError("must be one of enum values ('Employee', 'Employee_Budgeted_Compensation', 'Employment_Start', 'Employment_Exit', 'Absenteeism', 'Supervisory', 'Organization', 'Compensation_Payout', 'CustomSubject', 'TestConnectionSubject', 'Internal_Placement', 'Pay_Change', 'Hire', 'Applicant', 'Candidate', 'Requisition')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerSubjectMissingAccessDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerSubjectMissingAccessDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "subject": obj.get("subject"), + "attributes": obj.get("attributes"), + "errorMessage": obj.get("errorMessage") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_success_factors_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_success_factors_auth_params_dto.py new file mode 100644 index 0000000000..c4a2417c1e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_success_factors_auth_params_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_success_factors_o_auth_params_dto import DesignerSuccessFactorsOAuthParamsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerSuccessFactorsAuthParamsDTO(BaseModel): + """ + DesignerSuccessFactorsAuthParamsDTO + """ # noqa: E501 + host_domain_name: Optional[StrictStr] = Field(default=None, alias="hostDomainName") + company_id: Optional[StrictStr] = Field(default=None, alias="companyID") + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + o_auth: Optional[DesignerSuccessFactorsOAuthParamsDTO] = Field(default=None, alias="oAuth") + __properties: ClassVar[List[str]] = ["hostDomainName", "companyID", "username", "password", "oAuth"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerSuccessFactorsAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of o_auth + if self.o_auth: + _dict['oAuth'] = self.o_auth.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerSuccessFactorsAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hostDomainName": obj.get("hostDomainName"), + "companyID": obj.get("companyID"), + "username": obj.get("username"), + "password": obj.get("password"), + "oAuth": DesignerSuccessFactorsOAuthParamsDTO.from_dict(obj["oAuth"]) if obj.get("oAuth") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_success_factors_o_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_success_factors_o_auth_params_dto.py new file mode 100644 index 0000000000..27bdd31d5b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_success_factors_o_auth_params_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerSuccessFactorsOAuthParamsDTO(BaseModel): + """ + DesignerSuccessFactorsOAuthParamsDTO + """ # noqa: E501 + api_key: Optional[StrictStr] = Field(default=None, alias="apiKey") + private_x509_key: Optional[StrictStr] = Field(default=None, alias="privateX509Key") + public_x509_cert: Optional[StrictStr] = Field(default=None, alias="publicX509Cert") + __properties: ClassVar[List[str]] = ["apiKey", "privateX509Key", "publicX509Cert"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerSuccessFactorsOAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerSuccessFactorsOAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "apiKey": obj.get("apiKey"), + "privateX509Key": obj.get("privateX509Key"), + "publicX509Cert": obj.get("publicX509Cert") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_tenant_module_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_tenant_module_dto.py new file mode 100644 index 0000000000..f5306f910a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_tenant_module_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_module_settings_dto import DesignerModuleSettingsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerTenantModuleDTO(BaseModel): + """ + DesignerTenantModuleDTO + """ # noqa: E501 + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name that is displayed within Visier. For example, \"TALENT\".", alias="displayName") + symbol_name: Optional[StrictStr] = Field(default=None, description="The symbol name of the module. For example, \"Talent_Management\".", alias="symbolName") + module_settings: Optional[DesignerModuleSettingsDTO] = Field(default=None, description="The settings associated with the module.", alias="moduleSettings") + __properties: ClassVar[List[str]] = ["displayName", "symbolName", "moduleSettings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerTenantModuleDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of module_settings + if self.module_settings: + _dict['moduleSettings'] = self.module_settings.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerTenantModuleDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "displayName": obj.get("displayName"), + "symbolName": obj.get("symbolName"), + "moduleSettings": DesignerModuleSettingsDTO.from_dict(obj["moduleSettings"]) if obj.get("moduleSettings") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_ultimate_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_ultimate_auth_params_dto.py new file mode 100644 index 0000000000..fc6c909a2e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_ultimate_auth_params_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerUltimateAuthParamsDTO(BaseModel): + """ + DesignerUltimateAuthParamsDTO + """ # noqa: E501 + host_domain_name: Optional[StrictStr] = Field(default=None, alias="hostDomainName") + api_key: Optional[StrictStr] = Field(default=None, alias="apiKey") + username: Optional[StrictStr] = None + password: Optional[StrictStr] = None + user_access_key: Optional[StrictStr] = Field(default=None, alias="userAccessKey") + __properties: ClassVar[List[str]] = ["hostDomainName", "apiKey", "username", "password", "userAccessKey"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerUltimateAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerUltimateAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hostDomainName": obj.get("hostDomainName"), + "apiKey": obj.get("apiKey"), + "username": obj.get("username"), + "password": obj.get("password"), + "userAccessKey": obj.get("userAccessKey") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_basic_auth_credential_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_basic_auth_credential_dto.py new file mode 100644 index 0000000000..7d2292fe02 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_basic_auth_credential_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWebhookWebhookBasicAuthCredentialDTO(BaseModel): + """ + The basic authentication credentials for the webhook. + """ # noqa: E501 + username: Optional[StrictStr] = Field(default=None, description="The username for the webhook credential.") + password: Optional[StrictStr] = Field(default=None, description="The password for the webhook credential.") + __properties: ClassVar[List[str]] = ["username", "password"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookBasicAuthCredentialDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookBasicAuthCredentialDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "username": obj.get("username"), + "password": obj.get("password") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_credentials_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_credentials_dto.py new file mode 100644 index 0000000000..fe5696a9c8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_credentials_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_webhook_webhook_basic_auth_credential_dto import DesignerWebhookWebhookBasicAuthCredentialDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWebhookWebhookCredentialsDTO(BaseModel): + """ + The credentials to authenticate calls to the webhook endpoint. Must be one of `basicAuth` or `accessToken`. + """ # noqa: E501 + basic_auth: Optional[DesignerWebhookWebhookBasicAuthCredentialDTO] = Field(default=None, description="Authentication using a username and password.", alias="basicAuth") + access_token: Optional[StrictStr] = Field(default=None, description="Authentication using an access token.", alias="accessToken") + __properties: ClassVar[List[str]] = ["basicAuth", "accessToken"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookCredentialsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of basic_auth + if self.basic_auth: + _dict['basicAuth'] = self.basic_auth.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookCredentialsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "basicAuth": DesignerWebhookWebhookBasicAuthCredentialDTO.from_dict(obj["basicAuth"]) if obj.get("basicAuth") is not None else None, + "accessToken": obj.get("accessToken") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_details_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_details_dto.py new file mode 100644 index 0000000000..1da65836be --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_details_dto.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_webhook_webhook_event_type_dto import DesignerWebhookWebhookEventTypeDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWebhookWebhookDetailsDTO(BaseModel): + """ + Information about the webhook, such as its URL, active status, and event types to listen for. + """ # noqa: E501 + target_url: Optional[StrictStr] = Field(default=None, description="The target URL to call when an event occurs.", alias="targetUrl") + is_active: Optional[StrictBool] = Field(default=None, description="If `true`, the webhook is active. Default is `true`.", alias="isActive") + events: Optional[List[DesignerWebhookWebhookEventTypeDTO]] = Field(default=None, description="The events that the webhook is listening for. Valid values: - `jobResultSuccess`: A job completed successfully. - `jobResultFailure`: A job failed to complete. - `jobReschedule`: A job was rescheduled. - `dvPublish`: A data version published to production.") + key_name: Optional[StrictStr] = Field(default=None, description="The display name of the encryption key for the webhook.", alias="keyName") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the webhook.", alias="displayName") + __properties: ClassVar[List[str]] = ["targetUrl", "isActive", "events", "keyName", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookDetailsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in events (list) + _items = [] + if self.events: + for _item_events in self.events: + if _item_events: + _items.append(_item_events.to_dict()) + _dict['events'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookDetailsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "targetUrl": obj.get("targetUrl"), + "isActive": obj.get("isActive"), + "events": [DesignerWebhookWebhookEventTypeDTO.from_dict(_item) for _item in obj["events"]] if obj.get("events") is not None else None, + "keyName": obj.get("keyName"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_dto.py new file mode 100644 index 0000000000..b2a6dfa7c2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_webhook_webhook_details_dto import DesignerWebhookWebhookDetailsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWebhookWebhookDTO(BaseModel): + """ + The webhook's details, such as its URL, active status, and event types to listen for. + """ # noqa: E501 + webhook_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the webhook.", alias="webhookId") + details: Optional[DesignerWebhookWebhookDetailsDTO] = Field(default=None, description="The webhook's details, such as its URL, active status, and event types to listen for.") + credential_reference: Optional[StrictStr] = Field(default=None, description="The unique identifier of the configured webhook credentials.", alias="credentialReference") + __properties: ClassVar[List[str]] = ["webhookId", "details", "credentialReference"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of details + if self.details: + _dict['details'] = self.details.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "webhookId": obj.get("webhookId"), + "details": DesignerWebhookWebhookDetailsDTO.from_dict(obj["details"]) if obj.get("details") is not None else None, + "credentialReference": obj.get("credentialReference") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_event_type_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_event_type_dto.py new file mode 100644 index 0000000000..ecf0339590 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_event_type_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWebhookWebhookEventTypeDTO(BaseModel): + """ + The possible event types for Visier webhooks. + """ # noqa: E501 + event_type: Optional[StrictStr] = Field(default=None, description="The possible event types to listen for. Valid values: - `jobResultSuccess`: A job completed successfully. - `jobResultFailure`: A job failed to complete. - `jobReschedule`: A job was rescheduled. - `dvPublish`: A data version published to production.", alias="eventType") + __properties: ClassVar[List[str]] = ["eventType"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookEventTypeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookEventTypeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "eventType": obj.get("eventType") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_message_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_message_response_dto.py new file mode 100644 index 0000000000..a664531b36 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_message_response_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWebhookWebhookMessageResponseDTO(BaseModel): + """ + The results of the webhook notification attempt. + """ # noqa: E501 + status_code: Optional[StrictInt] = Field(default=None, description="The standard HTTP response code to inform you of the success or failure of the webhook notification attempt.", alias="statusCode") + message: Optional[StrictStr] = Field(default=None, description="Information about the notification attempt.") + message_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the message.", alias="messageId") + event_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the event that triggered the webhook notification.", alias="eventId") + __properties: ClassVar[List[str]] = ["statusCode", "message", "messageId", "eventId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookMessageResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookMessageResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "statusCode": obj.get("statusCode"), + "message": obj.get("message"), + "messageId": obj.get("messageId"), + "eventId": obj.get("eventId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_request_dto.py new file mode 100644 index 0000000000..01ee88640a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhook_request_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_webhook_webhook_credentials_dto import DesignerWebhookWebhookCredentialsDTO +from visier_platform_sdk.models.designer_webhook_webhook_details_dto import DesignerWebhookWebhookDetailsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWebhookWebhookRequestDTO(BaseModel): + """ + The details and credentials for a webhook. + """ # noqa: E501 + details: Optional[DesignerWebhookWebhookDetailsDTO] = Field(default=None, description="The webhook's details, such as its URL, active status, and event types to listen for.") + credentials: Optional[DesignerWebhookWebhookCredentialsDTO] = Field(default=None, description="The webhook's credentials, such as a username and password or access token.") + __properties: ClassVar[List[str]] = ["details", "credentials"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of details + if self.details: + _dict['details'] = self.details.to_dict() + # override the default output from pydantic by calling `to_dict()` of credentials + if self.credentials: + _dict['credentials'] = self.credentials.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhookRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "details": DesignerWebhookWebhookDetailsDTO.from_dict(obj["details"]) if obj.get("details") is not None else None, + "credentials": DesignerWebhookWebhookCredentialsDTO.from_dict(obj["credentials"]) if obj.get("credentials") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhooks_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhooks_dto.py new file mode 100644 index 0000000000..34ea450c91 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_webhook_webhooks_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_webhook_webhook_dto import DesignerWebhookWebhookDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWebhookWebhooksDTO(BaseModel): + """ + The returned list of webhooks. + """ # noqa: E501 + webhooks: Optional[List[DesignerWebhookWebhookDTO]] = Field(default=None, description="A list of webhooks.") + __properties: ClassVar[List[str]] = ["webhooks"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhooksDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in webhooks (list) + _items = [] + if self.webhooks: + for _item_webhooks in self.webhooks: + if _item_webhooks: + _items.append(_item_webhooks.to_dict()) + _dict['webhooks'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWebhookWebhooksDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "webhooks": [DesignerWebhookWebhookDTO.from_dict(_item) for _item in obj["webhooks"]] if obj.get("webhooks") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_willow_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_willow_auth_params_dto.py new file mode 100644 index 0000000000..c695464195 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_willow_auth_params_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWillowAuthParamsDTO(BaseModel): + """ + DesignerWillowAuthParamsDTO + """ # noqa: E501 + api_token: Optional[StrictStr] = Field(default=None, alias="apiToken") + host_name: Optional[StrictStr] = Field(default=None, alias="hostName") + __properties: ClassVar[List[str]] = ["apiToken", "hostName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWillowAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWillowAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "apiToken": obj.get("apiToken"), + "hostName": obj.get("hostName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_auth_params_dto.py new file mode 100644 index 0000000000..37f54c69ee --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_auth_params_dto.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.designer_workday_o_auth_params_dto import DesignerWorkdayOAuthParamsDTO +from visier_platform_sdk.models.designer_workday_refresh_token_params_dto import DesignerWorkdayRefreshTokenParamsDTO +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWorkdayAuthParamsDTO(BaseModel): + """ + DesignerWorkdayAuthParamsDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, alias="userId") + domain_name: Optional[StrictStr] = Field(default=None, alias="domainName") + implementation_name: Optional[StrictStr] = Field(default=None, alias="implementationName") + password: Optional[StrictStr] = None + o_auth: Optional[DesignerWorkdayOAuthParamsDTO] = Field(default=None, alias="oAuth") + ref_token: Optional[DesignerWorkdayRefreshTokenParamsDTO] = Field(default=None, alias="refToken") + integration_system_id: Optional[StrictStr] = Field(default=None, alias="integrationSystemId") + api_key: Optional[StrictStr] = Field(default=None, alias="apiKey") + __properties: ClassVar[List[str]] = ["userId", "domainName", "implementationName", "password", "oAuth", "refToken", "integrationSystemId", "apiKey"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWorkdayAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of o_auth + if self.o_auth: + _dict['oAuth'] = self.o_auth.to_dict() + # override the default output from pydantic by calling `to_dict()` of ref_token + if self.ref_token: + _dict['refToken'] = self.ref_token.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWorkdayAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "domainName": obj.get("domainName"), + "implementationName": obj.get("implementationName"), + "password": obj.get("password"), + "oAuth": DesignerWorkdayOAuthParamsDTO.from_dict(obj["oAuth"]) if obj.get("oAuth") is not None else None, + "refToken": DesignerWorkdayRefreshTokenParamsDTO.from_dict(obj["refToken"]) if obj.get("refToken") is not None else None, + "integrationSystemId": obj.get("integrationSystemId"), + "apiKey": obj.get("apiKey") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_o_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_o_auth_params_dto.py new file mode 100644 index 0000000000..7452cf7aa2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_o_auth_params_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWorkdayOAuthParamsDTO(BaseModel): + """ + DesignerWorkdayOAuthParamsDTO + """ # noqa: E501 + api_client_id: Optional[StrictStr] = Field(default=None, alias="apiClientId") + public_x509_cert: Optional[StrictStr] = Field(default=None, alias="publicX509Cert") + private_x509_key: Optional[StrictStr] = Field(default=None, alias="privateX509Key") + __properties: ClassVar[List[str]] = ["apiClientId", "publicX509Cert", "privateX509Key"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWorkdayOAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWorkdayOAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "apiClientId": obj.get("apiClientId"), + "publicX509Cert": obj.get("publicX509Cert"), + "privateX509Key": obj.get("privateX509Key") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_raas_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_raas_auth_params_dto.py new file mode 100644 index 0000000000..19a2bc1f96 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_raas_auth_params_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWorkdayRaasAuthParamsDTO(BaseModel): + """ + DesignerWorkdayRaasAuthParamsDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, alias="userId") + domain_name: Optional[StrictStr] = Field(default=None, alias="domainName") + implementation_name: Optional[StrictStr] = Field(default=None, alias="implementationName") + password: Optional[StrictStr] = None + test_report_url: Optional[StrictStr] = Field(default=None, alias="testReportUrl") + __properties: ClassVar[List[str]] = ["userId", "domainName", "implementationName", "password", "testReportUrl"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWorkdayRaasAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWorkdayRaasAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "domainName": obj.get("domainName"), + "implementationName": obj.get("implementationName"), + "password": obj.get("password"), + "testReportUrl": obj.get("testReportUrl") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_refresh_token_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_refresh_token_params_dto.py new file mode 100644 index 0000000000..1644080089 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_workday_refresh_token_params_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerWorkdayRefreshTokenParamsDTO(BaseModel): + """ + DesignerWorkdayRefreshTokenParamsDTO + """ # noqa: E501 + api_client_id: Optional[StrictStr] = Field(default=None, alias="apiClientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + refresh_token: Optional[StrictStr] = Field(default=None, alias="refreshToken") + __properties: ClassVar[List[str]] = ["apiClientId", "clientSecret", "refreshToken"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerWorkdayRefreshTokenParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerWorkdayRefreshTokenParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "apiClientId": obj.get("apiClientId"), + "clientSecret": obj.get("clientSecret"), + "refreshToken": obj.get("refreshToken") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/designer_zoom_auth_params_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/designer_zoom_auth_params_dto.py new file mode 100644 index 0000000000..03db7ebabc --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/designer_zoom_auth_params_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DesignerZoomAuthParamsDTO(BaseModel): + """ + DesignerZoomAuthParamsDTO + """ # noqa: E501 + auth_code: Optional[StrictStr] = Field(default=None, alias="authCode") + client_id: Optional[StrictStr] = Field(default=None, alias="clientId") + client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret") + __properties: ClassVar[List[str]] = ["authCode", "clientId", "clientSecret"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignerZoomAuthParamsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignerZoomAuthParamsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "authCode": obj.get("authCode"), + "clientId": obj.get("clientId"), + "clientSecret": obj.get("clientSecret") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dimension_member.py b/src/visier_platform_sdk/visier_platform_sdk/models/dimension_member.py new file mode 100644 index 0000000000..1faa6c5621 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dimension_member.py @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.description_entry import DescriptionEntry +from typing import Optional, Set +from typing_extensions import Self + +class DimensionMember(BaseModel): + """ + An element of a dimension that can be organized hierarchically. + """ # noqa: E501 + id: StrictStr = Field(description="Unique identifier of the member.") + name: StrictStr = Field(description="Name of the member.") + description: StrictStr = Field(description="Description of the member.") + has_benchmark_value: StrictBool = Field(description="True if this member has available benchmark values. False if this member has no available benchmark values. ", alias="hasBenchmarkValue") + has_children: StrictBool = Field(description="True if this member has children. False if this member has no children. For example, a leaf member. ", alias="hasChildren") + status: StrictStr = Field(description="Status of the member. If status is `archived`, the dimension member does not have a benchmark value.") + display_id: Optional[StrictStr] = Field(default=None, description="A user-friendly identifier of the member. This field will be excluded from the response if there is no displayId for the member.", alias="displayId") + short_description_sections: Optional[List[DescriptionEntry]] = Field(default=None, description="A short description of the member in structured format.", alias="shortDescriptionSections") + job_domain: Optional[StrictStr] = Field(default=None, description="Domain of a job member. This field will be excluded from the response if there is no domain for the member.", alias="jobDomain") + job_subdomain: Optional[StrictStr] = Field(default=None, description="Subdomain of a job member. This field will be excluded from the response if there is no subdomain for the member.", alias="jobSubdomain") + typical_titles: Optional[List[StrictStr]] = Field(default=None, description="Similar job titles for a job member. This field will be excluded from the response if there are no similar job titles.", alias="typicalTitles") + related_jobs: Optional[List[StrictStr]] = Field(default=None, description="The job IDs for similar jobs, sorted in descending order of similarity. This field will be excluded from the response if there are no similar jobs.", alias="relatedJobs") + naics_id: Optional[StrictStr] = Field(default=None, description="The North American Industry Classification System (NAICS) code that matches the provided naicsCode, using NAICS version 2022.", alias="naicsId") + naics_name: Optional[StrictStr] = Field(default=None, description="The name of the North American Industry Classification System (NAICS) category that matches the provided naicsCode, using NAICS version 2022.", alias="naicsName") + naics_description: Optional[StrictStr] = Field(default=None, description="The description of the North American Industry Classification System (NAICS) category that matches the provided naicsCode, using NAICS version 2022.", alias="naicsDescription") + soc_code: Optional[StrictStr] = Field(default=None, description="The Standard Occupational Classification (SOC) code for the job member, using SOC version 2018. This optional field is returned if a single SOC code maps to the job member.", alias="socCode") + soc_name: Optional[StrictStr] = Field(default=None, description="The detailed occupation name from the Standard Occupational Classification (SOC) system for the job member, using SOC version 2018. This optional field is returned if a single SOC code maps to the job member.", alias="socName") + soc_codes: Optional[Dict[str, Any]] = Field(default=None, description="The Standard Occupational Classification (SOC) codes for the job member mapped to career level ids, using SOC version 2018. This optional field is returned if multiple SOC codes map to different career levels of the job member.", alias="socCodes") + soc_names: Optional[Dict[str, Any]] = Field(default=None, description="The detailed occupation names from the Standard Occupational Classification (SOC) system for the job member mapped to career level ids, using SOC version 2018. This optional field is returned if multiple SOC codes map to different career levels of the job member.", alias="socNames") + __properties: ClassVar[List[str]] = ["id", "name", "description", "hasBenchmarkValue", "hasChildren", "status", "displayId", "shortDescriptionSections", "jobDomain", "jobSubdomain", "typicalTitles", "relatedJobs", "naicsId", "naicsName", "naicsDescription", "socCode", "socName", "socCodes", "socNames"] + + @field_validator('status') + def status_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['active', 'archived']): + raise ValueError("must be one of enum values ('active', 'archived')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DimensionMember from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in short_description_sections (list) + _items = [] + if self.short_description_sections: + for _item_short_description_sections in self.short_description_sections: + if _item_short_description_sections: + _items.append(_item_short_description_sections.to_dict()) + _dict['shortDescriptionSections'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DimensionMember from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description"), + "hasBenchmarkValue": obj.get("hasBenchmarkValue"), + "hasChildren": obj.get("hasChildren"), + "status": obj.get("status"), + "displayId": obj.get("displayId"), + "shortDescriptionSections": [DescriptionEntry.from_dict(_item) for _item in obj["shortDescriptionSections"]] if obj.get("shortDescriptionSections") is not None else None, + "jobDomain": obj.get("jobDomain"), + "jobSubdomain": obj.get("jobSubdomain"), + "typicalTitles": obj.get("typicalTitles"), + "relatedJobs": obj.get("relatedJobs"), + "naicsId": obj.get("naicsId"), + "naicsName": obj.get("naicsName"), + "naicsDescription": obj.get("naicsDescription"), + "socCode": obj.get("socCode"), + "socName": obj.get("socName"), + "socCodes": obj.get("socCodes"), + "socNames": obj.get("socNames") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/direct_data_upload_file_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/direct_data_upload_file_response_dto.py new file mode 100644 index 0000000000..aab3598481 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/direct_data_upload_file_response_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DirectDataUploadFileResponseDTO(BaseModel): + """ + The transaction results. If uploading a file, a success response means the upload was successful and doesn't always mean the file was successfully loaded into its target object. + """ # noqa: E501 + transaction_id: Optional[StrictStr] = Field(default=None, description="The unique transaction identifier.", alias="transactionId") + status: Optional[StrictStr] = Field(default=None, description="The status of the request.") + message: Optional[StrictStr] = Field(default=None, description="The upload response message from the provisioning service.") + __properties: ClassVar[List[str]] = ["transactionId", "status", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DirectDataUploadFileResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DirectDataUploadFileResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "transactionId": obj.get("transactionId"), + "status": obj.get("status"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dp_automation_metric_validation_summary_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dp_automation_metric_validation_summary_dto.py new file mode 100644 index 0000000000..0cdbb2833f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dp_automation_metric_validation_summary_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class DpAutomationMetricValidationSummaryDTO(BaseModel): + """ + DpAutomationMetricValidationSummaryDTO + """ # noqa: E501 + symbol_name: Optional[StrictStr] = Field(default=None, description="The symbol name of the metric. For example, \"employeeCount\".", alias="symbolName") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name that is displayed within Visier. For example, \"Headcount\".", alias="displayName") + value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The current value of the metric expressed as an integer.") + __properties: ClassVar[List[str]] = ["symbolName", "displayName", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DpAutomationMetricValidationSummaryDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DpAutomationMetricValidationSummaryDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "symbolName": obj.get("symbolName"), + "displayName": obj.get("displayName"), + "value": obj.get("value") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_dto.py new file mode 100644 index 0000000000..b0c08b14d1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dp_automation_metric_validation_summary_dto import DpAutomationMetricValidationSummaryDTO +from typing import Optional, Set +from typing_extensions import Self + +class DpAutomationTenantPreviewEntriesSummaryDTO(BaseModel): + """ + DpAutomationTenantPreviewEntriesSummaryDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant. For example, \"WFF_j1r~i1o\".", alias="tenantCode") + data_version: Optional[StrictStr] = Field(default=None, description="The data version ID.", alias="dataVersion") + data_version_date: Optional[StrictStr] = Field(default=None, description="The date that the data version was created.", alias="dataVersionDate") + metrics: Optional[List[DpAutomationMetricValidationSummaryDTO]] = Field(default=None, description="A list of metrics and their values.") + __properties: ClassVar[List[str]] = ["tenantCode", "dataVersion", "dataVersionDate", "metrics"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DpAutomationTenantPreviewEntriesSummaryDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in metrics (list) + _items = [] + if self.metrics: + for _item_metrics in self.metrics: + if _item_metrics: + _items.append(_item_metrics.to_dict()) + _dict['metrics'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DpAutomationTenantPreviewEntriesSummaryDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "dataVersion": obj.get("dataVersion"), + "dataVersionDate": obj.get("dataVersionDate"), + "metrics": [DpAutomationMetricValidationSummaryDTO.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_list_dto.py new file mode 100644 index 0000000000..a3110b82ea --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_list_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dp_automation_tenant_preview_entries_summary_dto import DpAutomationTenantPreviewEntriesSummaryDTO +from typing import Optional, Set +from typing_extensions import Self + +class DpAutomationTenantPreviewEntriesSummaryListDTO(BaseModel): + """ + DpAutomationTenantPreviewEntriesSummaryListDTO + """ # noqa: E501 + tenants: Optional[List[DpAutomationTenantPreviewEntriesSummaryDTO]] = Field(default=None, description="A list of objects representing all the analytic tenants.") + limit: Optional[StrictInt] = Field(default=None, description="The number of analytic tenants to retrieve. The maximum number to retrieve is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving results from, also known as offset. The index begins at 0.") + __properties: ClassVar[List[str]] = ["tenants", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DpAutomationTenantPreviewEntriesSummaryListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DpAutomationTenantPreviewEntriesSummaryListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [DpAutomationTenantPreviewEntriesSummaryDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dp_cancel_job_batch_from_job_id_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dp_cancel_job_batch_from_job_id_dto.py new file mode 100644 index 0000000000..9160845a9e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dp_cancel_job_batch_from_job_id_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DpCancelJobBatchFromJobIdDTO(BaseModel): + """ + DpCancelJobBatchFromJobIdDTO + """ # noqa: E501 + job_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of jobs to cancel. The maximum number of jobs that can be cancelled is 500.", alias="jobIds") + __properties: ClassVar[List[str]] = ["jobIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DpCancelJobBatchFromJobIdDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DpCancelJobBatchFromJobIdDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobIds": obj.get("jobIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dp_job_cancellation_result_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dp_job_cancellation_result_dto.py new file mode 100644 index 0000000000..506bf8374a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dp_job_cancellation_result_dto.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DpJobCancellationResultDTO(BaseModel): + """ + DpJobCancellationResultDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The analytic tenant whose job the cancel operation was conducted for.", alias="tenantCode") + job_id: Optional[StrictStr] = Field(default=None, description="The job ID of the job that the cancel operation was conducted for.", alias="jobId") + job_type: Optional[StrictStr] = Field(default=None, description="The job type associated with the job ID.", alias="jobType") + parent_job_id: Optional[StrictStr] = Field(default=None, description="If applicable, the job ID of the job that spawned the given job.", alias="parentJobId") + cancel_status: Optional[StrictStr] = Field(default=None, description="The status of the cancellation.", alias="cancelStatus") + job_status: Optional[StrictStr] = Field(default=None, description="The job status after the cancel operation. If successful, the status is either Cancelled or Cancelling.", alias="jobStatus") + message: Optional[StrictStr] = Field(default=None, description="If applicable, the message explains what errors occurred while cancelling the jobs.") + __properties: ClassVar[List[str]] = ["tenantCode", "jobId", "jobType", "parentJobId", "cancelStatus", "jobStatus", "message"] + + @field_validator('cancel_status') + def cancel_status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['CANCEL_FAILED', 'CANCEL_SUCCEEDED']): + raise ValueError("must be one of enum values ('CANCEL_FAILED', 'CANCEL_SUCCEEDED')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DpJobCancellationResultDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DpJobCancellationResultDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "jobId": obj.get("jobId"), + "jobType": obj.get("jobType"), + "parentJobId": obj.get("parentJobId"), + "cancelStatus": obj.get("cancelStatus"), + "jobStatus": obj.get("jobStatus"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dp_job_cancellation_results_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/dp_job_cancellation_results_dto.py new file mode 100644 index 0000000000..a2d04e2209 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dp_job_cancellation_results_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.dp_job_cancellation_result_dto import DpJobCancellationResultDTO +from typing import Optional, Set +from typing_extensions import Self + +class DpJobCancellationResultsDTO(BaseModel): + """ + DpJobCancellationResultsDTO + """ # noqa: E501 + job_cancellation_results: Optional[List[DpJobCancellationResultDTO]] = Field(default=None, description="A list of objects representing the job cancellation results.", alias="jobCancellationResults") + __properties: ClassVar[List[str]] = ["jobCancellationResults"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DpJobCancellationResultsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in job_cancellation_results (list) + _items = [] + if self.job_cancellation_results: + for _item_job_cancellation_results in self.job_cancellation_results: + if _item_job_cancellation_results: + _items.append(_item_job_cancellation_results.to_dict()) + _dict['jobCancellationResults'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DpJobCancellationResultsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobCancellationResults": [DpJobCancellationResultDTO.from_dict(_item) for _item in obj["jobCancellationResults"]] if obj.get("jobCancellationResults") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/dv_export_status.py b/src/visier_platform_sdk/visier_platform_sdk/models/dv_export_status.py new file mode 100644 index 0000000000..3ffc7b0ab5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/dv_export_status.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class DvExportStatus(BaseModel): + """ + The response structure for errors. + """ # noqa: E501 + localized_message: Optional[StrictStr] = Field(default=None, description="Localized error message describing the root cause of the error.", alias="localizedMessage") + error_code: Optional[StrictStr] = Field(default=None, description="Error classification.", alias="errorCode") + message: Optional[StrictStr] = Field(default=None, description="Not used.") + rci: Optional[StrictStr] = Field(default=None, description="Optional root cause identifier.") + user_error: Optional[StrictBool] = Field(default=None, description="Indicates whether the error is a user error.", alias="userError") + __properties: ClassVar[List[str]] = ["localizedMessage", "errorCode", "message", "rci", "userError"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DvExportStatus from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DvExportStatus from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "localizedMessage": obj.get("localizedMessage"), + "errorCode": obj.get("errorCode"), + "message": obj.get("message"), + "rci": obj.get("rci"), + "userError": obj.get("userError") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/extracted_skill.py b/src/visier_platform_sdk/visier_platform_sdk/models/extracted_skill.py new file mode 100644 index 0000000000..f2d9c49712 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/extracted_skill.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ExtractedSkill(BaseModel): + """ + ExtractedSkill + """ # noqa: E501 + id: StrictStr = Field(description="The unique ID of the skill. ") + name: StrictStr = Field(description="The localized display name of the skill. ") + description: StrictStr = Field(description="The localized description of the skill. ") + score: StrictInt = Field(description="The score representing the confidence level of the match between the extracted skill and the standardized skill in Visier’s Skills Library. The score ranges from 0 to 100. ") + __properties: ClassVar[List[str]] = ["id", "name", "description", "score"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExtractedSkill from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExtractedSkill from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description"), + "score": obj.get("score") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/generate_impersonation_token_request.py b/src/visier_platform_sdk/visier_platform_sdk/models/generate_impersonation_token_request.py new file mode 100644 index 0000000000..271aa4ae22 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/generate_impersonation_token_request.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class GenerateImpersonationTokenRequest(BaseModel): + """ + The details of the user to impersonate. + """ # noqa: E501 + target_username: Optional[StrictStr] = Field(default=None, description="The username of the user to impersonate.", alias="TargetUsername") + __properties: ClassVar[List[str]] = ["TargetUsername"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GenerateImpersonationTokenRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GenerateImpersonationTokenRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "TargetUsername": obj.get("TargetUsername") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/google_protobuf_any.py b/src/visier_platform_sdk/visier_platform_sdk/models/google_protobuf_any.py new file mode 100644 index 0000000000..2eb5a50a65 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/google_protobuf_any.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class GoogleProtobufAny(BaseModel): + """ + Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. + """ # noqa: E501 + type: Optional[StrictStr] = Field(default=None, description="The type of the serialized message.", alias="@type") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["@type"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GoogleProtobufAny from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GoogleProtobufAny from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "@type": obj.get("@type") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/hierarchy.py b/src/visier_platform_sdk/visier_platform_sdk/models/hierarchy.py new file mode 100644 index 0000000000..66545b10c1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/hierarchy.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class Hierarchy(BaseModel): + """ + Information describing a hierarchy, which is used to organize members of a dimension. + """ # noqa: E501 + id: StrictStr = Field(description="Unique identifier of the hierarchy.") + name: StrictStr = Field(description="Name of the hierarchy.") + description: Optional[StrictStr] = Field(default=None, description="Description of the hierarchy.") + __properties: ClassVar[List[str]] = ["id", "name", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Hierarchy from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Hierarchy from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/job.py b/src/visier_platform_sdk/visier_platform_sdk/models/job.py new file mode 100644 index 0000000000..7d0c032d0d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/job.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from visier_platform_sdk.models.skill import Skill +from typing import Optional, Set +from typing_extensions import Self + +class Job(BaseModel): + """ + Details describing a job. + """ # noqa: E501 + id: StrictStr = Field(description="The unique ID of the job. ") + name: StrictStr = Field(description="The localized display name of the job. ") + description: StrictStr = Field(description="The localized description of the job. ") + isco_code: Optional[StrictStr] = Field(default=None, description="The International Standard Classification of Occupations (ISCO) code of the job. This field will be omitted if the job is not associated with an ISCO code. ", alias="iscoCode") + soc_code: Optional[StrictStr] = Field(default=None, description="The Standard Occupational Classification (SOC) code of the job. This field will be omitted if the job is not associated with a SOC code. ", alias="socCode") + alternative_titles: List[StrictStr] = Field(description="List of alternative localized names for this job. ", alias="alternativeTitles") + essential_skills: List[Skill] = Field(description="List of essential skills for this job. ", alias="essentialSkills") + optional_skills: List[Skill] = Field(description="List of optional skills for this job. ", alias="optionalSkills") + remote_index: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The Remote Index represents how readily a job can be done through remote work. The index ranges from 0 to 100, where a value of 100 means the job can be done entirely remotely. This field will be omitted if remotability is not applicable to the job. ", alias="remoteIndex") + automation_index: Optional[StrictInt] = Field(default=None, description="The Automation Index represents how readily a job can be automated. The index ranges from 0 to 100, where a value of 100 means the job is completely automatable. This field will be omitted if automation is not applicable to the job. ", alias="automationIndex") + __properties: ClassVar[List[str]] = ["id", "name", "description", "iscoCode", "socCode", "alternativeTitles", "essentialSkills", "optionalSkills", "remoteIndex", "automationIndex"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Job from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in essential_skills (list) + _items = [] + if self.essential_skills: + for _item_essential_skills in self.essential_skills: + if _item_essential_skills: + _items.append(_item_essential_skills.to_dict()) + _dict['essentialSkills'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in optional_skills (list) + _items = [] + if self.optional_skills: + for _item_optional_skills in self.optional_skills: + if _item_optional_skills: + _items.append(_item_optional_skills.to_dict()) + _dict['optionalSkills'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Job from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description"), + "iscoCode": obj.get("iscoCode"), + "socCode": obj.get("socCode"), + "alternativeTitles": obj.get("alternativeTitles"), + "essentialSkills": [Skill.from_dict(_item) for _item in obj["essentialSkills"]] if obj.get("essentialSkills") is not None else None, + "optionalSkills": [Skill.from_dict(_item) for _item in obj["optionalSkills"]] if obj.get("optionalSkills") is not None else None, + "remoteIndex": obj.get("remoteIndex"), + "automationIndex": obj.get("automationIndex") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/job_entry.py b/src/visier_platform_sdk/visier_platform_sdk/models/job_entry.py new file mode 100644 index 0000000000..af22e8297c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/job_entry.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JobEntry(BaseModel): + """ + JobEntry + """ # noqa: E501 + id: StrictStr = Field(description="The unique ID of the job. ") + name: StrictStr = Field(description="The localized display name of the job. ") + description: StrictStr = Field(description="The localized description of the job. ") + __properties: ClassVar[List[str]] = ["id", "name", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JobEntry from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JobEntry from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/job_feedback_input.py b/src/visier_platform_sdk/visier_platform_sdk/models/job_feedback_input.py new file mode 100644 index 0000000000..f8a69d38f0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/job_feedback_input.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JobFeedbackInput(BaseModel): + """ + The data structure used to submit negative feedback for the job match results returned by the Get jobs endpoint. + """ # noqa: E501 + term: StrictStr = Field(description="The search term (job title) you entered when using the Get jobs endpoint. You're providing feedback on the quality of the search results for this term. This field is required. The minimum is 3 characters and the maximum is 100 characters. ") + naics_code: Optional[StrictStr] = Field(default=None, description="If provided, the naicsCode entered when using the Get jobs endpoint. You're providing feedback on the quality of the results for the search term and code.", alias="naicsCode") + additional_comments: Optional[StrictStr] = Field(default=None, description="Additional written feedback about the job match results returned by the Get jobs endpoint. The maximum is 150 characters. ", alias="additionalComments") + __properties: ClassVar[List[str]] = ["term", "naicsCode", "additionalComments"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JobFeedbackInput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JobFeedbackInput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "term": obj.get("term"), + "naicsCode": obj.get("naicsCode"), + "additionalComments": obj.get("additionalComments") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/job_search_failure_output.py b/src/visier_platform_sdk/visier_platform_sdk/models/job_search_failure_output.py new file mode 100644 index 0000000000..553bb51140 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/job_search_failure_output.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JobSearchFailureOutput(BaseModel): + """ + JobSearchFailureOutput + """ # noqa: E501 + http_status: StrictStr = Field(description="A three-digit code that indicates the outcome of a request. ", alias="httpStatus") + message: StrictStr = Field(description="The details of the error. ") + rci: StrictStr = Field(description="A root cause identifier that allows Visier to determine the source of the problem. ") + error_code: StrictStr = Field(description="A brief identifier of the type of error. ", alias="errorCode") + __properties: ClassVar[List[str]] = ["httpStatus", "message", "rci", "errorCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JobSearchFailureOutput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JobSearchFailureOutput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "httpStatus": obj.get("httpStatus"), + "message": obj.get("message"), + "rci": obj.get("rci"), + "errorCode": obj.get("errorCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/job_search_input.py b/src/visier_platform_sdk/visier_platform_sdk/models/job_search_input.py new file mode 100644 index 0000000000..35815803be --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/job_search_input.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class JobSearchInput(BaseModel): + """ + JobSearchInput + """ # noqa: E501 + job_ids: List[StrictStr] = Field(description="A list of job IDs to search jobs. The maximum number of job IDs is 1000. ", alias="jobIDs") + __properties: ClassVar[List[str]] = ["jobIDs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JobSearchInput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JobSearchInput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobIDs": obj.get("jobIDs") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/job_search_output.py b/src/visier_platform_sdk/visier_platform_sdk/models/job_search_output.py new file mode 100644 index 0000000000..a8365cb1a5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/job_search_output.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from visier_platform_sdk.models.dimension_member import DimensionMember +from visier_platform_sdk.models.job_search_failure_output import JobSearchFailureOutput +from typing import Optional, Set +from typing_extensions import Self + +class JobSearchOutput(BaseModel): + """ + JobSearchOutput + """ # noqa: E501 + successes: List[DimensionMember] = Field(description="The jobs retrieved for successful inputs. ") + failures: List[JobSearchFailureOutput] = Field(description="Error description for failed inputs. ") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JobSearchOutput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JobSearchOutput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [DimensionMember.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [JobSearchFailureOutput.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/job_standardization_input.py b/src/visier_platform_sdk/visier_platform_sdk/models/job_standardization_input.py new file mode 100644 index 0000000000..3879fce9c9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/job_standardization_input.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JobStandardizationInput(BaseModel): + """ + The custom job titles to standardize. + """ # noqa: E501 + terms: List[StrictStr] = Field(description="A list of input search terms. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. Your search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results. The maximum number of search terms is 30. For the individual search term, the minimum length is 3 characters and the maximum length is 100 characters. ") + naics_code: Optional[StrictStr] = Field(default=None, description="The North American Industry Classification System (NAICS) code. If `naicsCode` is provided, the most relevant job titles associated with the naicsCode are returned first. ", alias="naicsCode") + num_matches: Optional[StrictInt] = Field(default=5, description="The number of top matches to retrieve. ", alias="numMatches") + semantic_only: Optional[StrictBool] = Field(default=False, description="If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ", alias="semanticOnly") + lexical_only: Optional[StrictBool] = Field(default=False, description="If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ", alias="lexicalOnly") + typical_titles_search: Optional[StrictBool] = Field(default=False, description="If `true`, similar job titles for a job member are included in the lexical search for matches. Ensure the parameters 'lexicalOnly' is set to 'true' and 'semanticOnly' is set to 'false'. Default is `false`. ", alias="typicalTitlesSearch") + __properties: ClassVar[List[str]] = ["terms", "naicsCode", "numMatches", "semanticOnly", "lexicalOnly", "typicalTitlesSearch"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JobStandardizationInput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JobStandardizationInput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "terms": obj.get("terms"), + "naicsCode": obj.get("naicsCode"), + "numMatches": obj.get("numMatches") if obj.get("numMatches") is not None else 5, + "semanticOnly": obj.get("semanticOnly") if obj.get("semanticOnly") is not None else False, + "lexicalOnly": obj.get("lexicalOnly") if obj.get("lexicalOnly") is not None else False, + "typicalTitlesSearch": obj.get("typicalTitlesSearch") if obj.get("typicalTitlesSearch") is not None else False + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/job_standardization_input_skills.py b/src/visier_platform_sdk/visier_platform_sdk/models/job_standardization_input_skills.py new file mode 100644 index 0000000000..73bf21ef28 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/job_standardization_input_skills.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class JobStandardizationInputSkills(BaseModel): + """ + The custom job titles to standardize. + """ # noqa: E501 + jobs: List[StrictStr] + naics_code: Optional[StrictStr] = Field(default=None, description="The North American Industry Classification System (NAICS) code. If `naicsCode` is provided, the most relevant job titles associated with the naicsCode are returned first. ", alias="naicsCode") + __properties: ClassVar[List[str]] = ["jobs", "naicsCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of JobStandardizationInputSkills from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of JobStandardizationInputSkills from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobs": obj.get("jobs"), + "naicsCode": obj.get("naicsCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/location_search_failure_output.py b/src/visier_platform_sdk/visier_platform_sdk/models/location_search_failure_output.py new file mode 100644 index 0000000000..ade67569d4 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/location_search_failure_output.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class LocationSearchFailureOutput(BaseModel): + """ + LocationSearchFailureOutput + """ # noqa: E501 + uuid: StrictStr = Field(description="A unique identifier of the individual requests. ") + http_status: StrictStr = Field(description="A three-digit code that indicates the outcome of a request. ", alias="httpStatus") + message: StrictStr = Field(description="The details of the error. ") + rci: StrictStr = Field(description="A root cause identifier that allows Visier to determine the source of the problem. ") + error_code: StrictStr = Field(description="A brief identifier of the type of error. ", alias="errorCode") + __properties: ClassVar[List[str]] = ["uuid", "httpStatus", "message", "rci", "errorCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LocationSearchFailureOutput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LocationSearchFailureOutput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "httpStatus": obj.get("httpStatus"), + "message": obj.get("message"), + "rci": obj.get("rci"), + "errorCode": obj.get("errorCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/location_search_input.py b/src/visier_platform_sdk/visier_platform_sdk/models/location_search_input.py new file mode 100644 index 0000000000..585bb133ab --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/location_search_input.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.location_search_input1 import LocationSearchInput1 +from typing import Optional, Set +from typing_extensions import Self + +class LocationSearchInput(BaseModel): + """ + A list of location query parameters for bulk operation. The maximum batch size is 1000. + """ # noqa: E501 + search_inputs: List[LocationSearchInput1] = Field(alias="searchInputs") + has_benchmark_value: Optional[StrictBool] = Field(default=None, description="Filter members based on the availability of benchmark values. If `true`, members with benchmark values are returned. If `false`, members without benchmark values are returned. If no value is specified, all members are returned. ", alias="hasBenchmarkValue") + __properties: ClassVar[List[str]] = ["searchInputs", "hasBenchmarkValue"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LocationSearchInput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in search_inputs (list) + _items = [] + if self.search_inputs: + for _item_search_inputs in self.search_inputs: + if _item_search_inputs: + _items.append(_item_search_inputs.to_dict()) + _dict['searchInputs'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LocationSearchInput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "searchInputs": [LocationSearchInput1.from_dict(_item) for _item in obj["searchInputs"]] if obj.get("searchInputs") is not None else None, + "hasBenchmarkValue": obj.get("hasBenchmarkValue") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/location_search_input1.py b/src/visier_platform_sdk/visier_platform_sdk/models/location_search_input1.py new file mode 100644 index 0000000000..0cd4abd11d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/location_search_input1.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class LocationSearchInput1(BaseModel): + """ + LocationSearchInput1 + """ # noqa: E501 + uuid: StrictStr = Field(description="A unique identifier of the individual requests. ") + country_code: StrictStr = Field(description="The **ISO 3166-1** country code to look up. Returns location members that match the country code. Currently, the only supported country code is `US`. ", alias="countryCode") + postal_code: StrictStr = Field(description="The postal code to look up. Returns location members that match both the country code and postal code. ", alias="postalCode") + __properties: ClassVar[List[str]] = ["uuid", "countryCode", "postalCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LocationSearchInput1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LocationSearchInput1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "countryCode": obj.get("countryCode"), + "postalCode": obj.get("postalCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/location_search_output.py b/src/visier_platform_sdk/visier_platform_sdk/models/location_search_output.py new file mode 100644 index 0000000000..65bdfba084 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/location_search_output.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List +from visier_platform_sdk.models.location_search_failure_output import LocationSearchFailureOutput +from visier_platform_sdk.models.location_search_successful_output import LocationSearchSuccessfulOutput +from typing import Optional, Set +from typing_extensions import Self + +class LocationSearchOutput(BaseModel): + """ + LocationSearchOutput + """ # noqa: E501 + successes: List[LocationSearchSuccessfulOutput] = Field(description="The locations retrieved for successful inputs. ") + failures: List[LocationSearchFailureOutput] = Field(description="Error description for failed inputs. ") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LocationSearchOutput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LocationSearchOutput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [LocationSearchSuccessfulOutput.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [LocationSearchFailureOutput.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/location_search_successful_output.py b/src/visier_platform_sdk/visier_platform_sdk/models/location_search_successful_output.py new file mode 100644 index 0000000000..638d9b6d3d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/location_search_successful_output.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from visier_platform_sdk.models.dimension_member import DimensionMember +from typing import Optional, Set +from typing_extensions import Self + +class LocationSearchSuccessfulOutput(BaseModel): + """ + LocationSearchSuccessfulOutput + """ # noqa: E501 + uuid: StrictStr = Field(description="A unique identifier of the individual requests. ") + results: List[DimensionMember] = Field(description="A list of matching location members. ") + __properties: ClassVar[List[str]] = ["uuid", "results"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of LocationSearchSuccessfulOutput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in results (list) + _items = [] + if self.results: + for _item_results in self.results: + if _item_results: + _items.append(_item_results.to_dict()) + _dict['results'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of LocationSearchSuccessfulOutput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "results": [DimensionMember.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/output_entry.py b/src/visier_platform_sdk/visier_platform_sdk/models/output_entry.py new file mode 100644 index 0000000000..5ac70cbe74 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/output_entry.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from visier_platform_sdk.models.dimension_member import DimensionMember +from typing import Optional, Set +from typing_extensions import Self + +class OutputEntry(BaseModel): + """ + OutputEntry + """ # noqa: E501 + job: StrictStr = Field(description="The custom job title input. ") + matches: List[DimensionMember] = Field(description="The top standardized job matches. ") + __properties: ClassVar[List[str]] = ["job", "matches"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of OutputEntry from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in matches (list) + _items = [] + if self.matches: + for _item_matches in self.matches: + if _item_matches: + _items.append(_item_matches.to_dict()) + _dict['matches'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of OutputEntry from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "job": obj.get("job"), + "matches": [DimensionMember.from_dict(_item) for _item in obj["matches"]] if obj.get("matches") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/output_entry1.py b/src/visier_platform_sdk/visier_platform_sdk/models/output_entry1.py new file mode 100644 index 0000000000..0281fa8195 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/output_entry1.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from visier_platform_sdk.models.output_entry1_matches_inner import OutputEntry1MatchesInner +from typing import Optional, Set +from typing_extensions import Self + +class OutputEntry1(BaseModel): + """ + OutputEntry1 + """ # noqa: E501 + job: StrictStr = Field(description="The custom job title input. ") + matches: List[OutputEntry1MatchesInner] = Field(description="The top standardized job matches. ") + __properties: ClassVar[List[str]] = ["job", "matches"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of OutputEntry1 from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in matches (list) + _items = [] + if self.matches: + for _item_matches in self.matches: + if _item_matches: + _items.append(_item_matches.to_dict()) + _dict['matches'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of OutputEntry1 from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "job": obj.get("job"), + "matches": [OutputEntry1MatchesInner.from_dict(_item) for _item in obj["matches"]] if obj.get("matches") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/output_entry1_matches_inner.py b/src/visier_platform_sdk/visier_platform_sdk/models/output_entry1_matches_inner.py new file mode 100644 index 0000000000..62ab6c45ab --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/output_entry1_matches_inner.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class OutputEntry1MatchesInner(BaseModel): + """ + OutputEntry1MatchesInner + """ # noqa: E501 + id: StrictStr = Field(description="The unique ID of the job. ") + name: StrictStr = Field(description="The localized display name of the job. ") + description: StrictStr = Field(description="The localized description of the job. ") + score: StrictInt = Field(description="The score representing the confidence level of the match between the standardized job and the custom job title input. The score ranges from 0 to 100. ") + __properties: ClassVar[List[str]] = ["id", "name", "description", "score"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of OutputEntry1MatchesInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of OutputEntry1MatchesInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description"), + "score": obj.get("score") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/plan_data_load_change_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/plan_data_load_change_dto.py new file mode 100644 index 0000000000..05f668aad2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/plan_data_load_change_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class PlanDataLoadChangeDTO(BaseModel): + """ + PlanDataLoadChangeDTO + """ # noqa: E501 + row_members: Optional[List[StrictStr]] = Field(default=None, description="The collection of member ids that describe the row in the plan.", alias="rowMembers") + period: Optional[StrictStr] = Field(default=None, description="The display name of the time period.") + old_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The value that was replaced.", alias="oldValue") + new_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The new value loaded into the plan from the data load.", alias="newValue") + __properties: ClassVar[List[str]] = ["rowMembers", "period", "oldValue", "newValue"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanDataLoadChangeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanDataLoadChangeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "rowMembers": obj.get("rowMembers"), + "period": obj.get("period"), + "oldValue": obj.get("oldValue"), + "newValue": obj.get("newValue") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/plan_data_load_change_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/plan_data_load_change_list_dto.py new file mode 100644 index 0000000000..a9e3b4e4c1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/plan_data_load_change_list_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.plan_data_load_change_dto import PlanDataLoadChangeDTO +from typing import Optional, Set +from typing_extensions import Self + +class PlanDataLoadChangeListDTO(BaseModel): + """ + PlanDataLoadChangeListDTO + """ # noqa: E501 + plan_item: Optional[StrictStr] = Field(default=None, description="The ID of the plan item.", alias="planItem") + changes: Optional[List[PlanDataLoadChangeDTO]] = Field(default=None, description="The collection of changes made for the plan item.") + __properties: ClassVar[List[str]] = ["planItem", "changes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanDataLoadChangeListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in changes (list) + _items = [] + if self.changes: + for _item_changes in self.changes: + if _item_changes: + _items.append(_item_changes.to_dict()) + _dict['changes'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanDataLoadChangeListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "planItem": obj.get("planItem"), + "changes": [PlanDataLoadChangeDTO.from_dict(_item) for _item in obj["changes"]] if obj.get("changes") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/plan_data_upload_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/plan_data_upload_response_dto.py new file mode 100644 index 0000000000..c50a517f86 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/plan_data_upload_response_dto.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.plan_data_load_change_list_dto import PlanDataLoadChangeListDTO +from visier_platform_sdk.models.planning_plan_data_load_error_dto import PlanningPlanDataLoadErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class PlanDataUploadResponseDTO(BaseModel): + """ + PlanDataUploadResponseDTO + """ # noqa: E501 + updated_cells_count: Optional[StrictInt] = Field(default=None, description="The number of cells that were updated from the data load process.", alias="updatedCellsCount") + potential_updated_cells_count: Optional[StrictInt] = Field(default=None, description="The number of cells that would have been updated if all changes were saved.", alias="potentialUpdatedCellsCount") + errors: Optional[List[PlanningPlanDataLoadErrorDTO]] = Field(default=None, description="The collection of errors encountered during the data load process.") + changelists: Optional[List[PlanDataLoadChangeListDTO]] = Field(default=None, description="The collection of changes grouped by plan item made during the data load process. This list only contains the changes specified by the load. If you indicated in the request that the changes are to be rolled up or distributed, the values modified as a result of the calculations are not listed here.") + __properties: ClassVar[List[str]] = ["updatedCellsCount", "potentialUpdatedCellsCount", "errors", "changelists"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanDataUploadResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in errors (list) + _items = [] + if self.errors: + for _item_errors in self.errors: + if _item_errors: + _items.append(_item_errors.to_dict()) + _dict['errors'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in changelists (list) + _items = [] + if self.changelists: + for _item_changelists in self.changelists: + if _item_changelists: + _items.append(_item_changelists.to_dict()) + _dict['changelists'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanDataUploadResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "updatedCellsCount": obj.get("updatedCellsCount"), + "potentialUpdatedCellsCount": obj.get("potentialUpdatedCellsCount"), + "errors": [PlanningPlanDataLoadErrorDTO.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None, + "changelists": [PlanDataLoadChangeListDTO.from_dict(_item) for _item in obj["changelists"]] if obj.get("changelists") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/plan_row_data_load_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/plan_row_data_load_response_dto.py new file mode 100644 index 0000000000..a8df57cf9f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/plan_row_data_load_response_dto.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.planning_plan_data_load_error_dto import PlanningPlanDataLoadErrorDTO +from visier_platform_sdk.models.planning_plan_segment_level_member_dto import PlanningPlanSegmentLevelMemberDTO +from typing import Optional, Set +from typing_extensions import Self + +class PlanRowDataLoadResponseDTO(BaseModel): + """ + PlanRowDataLoadResponseDTO + """ # noqa: E501 + added_rows_count: Optional[StrictInt] = Field(default=None, description="The number of rows added to the plan.", alias="addedRowsCount") + removed_rows_count: Optional[StrictInt] = Field(default=None, description="The number of rows removed from the plan.", alias="removedRowsCount") + potential_added_rows_count: Optional[StrictInt] = Field(default=None, description="The number of rows that could have been added to the plan.", alias="potentialAddedRowsCount") + potential_removed_rows_count: Optional[StrictInt] = Field(default=None, description="The number of rows that could have been removed from the plan.", alias="potentialRemovedRowsCount") + errors: Optional[List[PlanningPlanDataLoadErrorDTO]] = Field(default=None, description="The errors that occurred while loading the data.") + custom_members: Optional[List[PlanningPlanSegmentLevelMemberDTO]] = Field(default=None, description="The custom members and their corresponding IDs in the plan.", alias="customMembers") + __properties: ClassVar[List[str]] = ["addedRowsCount", "removedRowsCount", "potentialAddedRowsCount", "potentialRemovedRowsCount", "errors", "customMembers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanRowDataLoadResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in errors (list) + _items = [] + if self.errors: + for _item_errors in self.errors: + if _item_errors: + _items.append(_item_errors.to_dict()) + _dict['errors'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in custom_members (list) + _items = [] + if self.custom_members: + for _item_custom_members in self.custom_members: + if _item_custom_members: + _items.append(_item_custom_members.to_dict()) + _dict['customMembers'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanRowDataLoadResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "addedRowsCount": obj.get("addedRowsCount"), + "removedRowsCount": obj.get("removedRowsCount"), + "potentialAddedRowsCount": obj.get("potentialAddedRowsCount"), + "potentialRemovedRowsCount": obj.get("potentialRemovedRowsCount"), + "errors": [PlanningPlanDataLoadErrorDTO.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None, + "customMembers": [PlanningPlanSegmentLevelMemberDTO.from_dict(_item) for _item in obj["customMembers"]] if obj.get("customMembers") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_get_plan_list_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_get_plan_list_response_dto.py new file mode 100644 index 0000000000..ab23ec8cba --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_get_plan_list_response_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.planning_plan_info_dto import PlanningPlanInfoDTO +from typing import Optional, Set +from typing_extensions import Self + +class PlanningGetPlanListResponseDTO(BaseModel): + """ + A collection of plans. + """ # noqa: E501 + plans: Optional[List[PlanningPlanInfoDTO]] = Field(default=None, description="A list of plans accessible to the user.") + page: Optional[StrictInt] = Field(default=None, description="The current page number of results that the user is viewing.") + __properties: ClassVar[List[str]] = ["plans", "page"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningGetPlanListResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in plans (list) + _items = [] + if self.plans: + for _item_plans in self.plans: + if _item_plans: + _items.append(_item_plans.to_dict()) + _dict['plans'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningGetPlanListResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "plans": [PlanningPlanInfoDTO.from_dict(_item) for _item in obj["plans"]] if obj.get("plans") is not None else None, + "page": obj.get("page") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_data_load_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_data_load_error_dto.py new file mode 100644 index 0000000000..a47fdd3a83 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_data_load_error_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class PlanningPlanDataLoadErrorDTO(BaseModel): + """ + An error encountered while loading plan data. + """ # noqa: E501 + row: Optional[StrictInt] = Field(default=None, description="The row in the file that caused the error.") + rci: Optional[StrictStr] = Field(default=None, description="An error code that can be provided to Visier Support to help investigate your issue.") + error_message: Optional[StrictStr] = Field(default=None, description="Information regarding the error and any actions that you could take to load the data correctly.", alias="errorMessage") + __properties: ClassVar[List[str]] = ["row", "rci", "errorMessage"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningPlanDataLoadErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningPlanDataLoadErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "row": obj.get("row"), + "rci": obj.get("rci"), + "errorMessage": obj.get("errorMessage") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_info_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_info_dto.py new file mode 100644 index 0000000000..b41451305a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_info_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.planning_scenario_info_dto import PlanningScenarioInfoDTO +from typing import Optional, Set +from typing_extensions import Self + +class PlanningPlanInfoDTO(BaseModel): + """ + Information about a plan and its scenarios. + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The UUID of the plan.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the plan.", alias="displayName") + model_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the planning model that the plan is using.", alias="modelId") + scenarios: Optional[List[PlanningScenarioInfoDTO]] = Field(default=None, description="Information about the plan's scenarios.") + parent_plan_uuid: Optional[StrictStr] = Field(default=None, description="If the plan is a subplan, the response returns its parent plan's UUID. Not returned for main plans.", alias="parentPlanUuid") + currency_code: Optional[StrictStr] = Field(default=None, description="The 3-digit ISO 4217 currency code of the plan's data.", alias="currencyCode") + __properties: ClassVar[List[str]] = ["uuid", "displayName", "modelId", "scenarios", "parentPlanUuid", "currencyCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningPlanInfoDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in scenarios (list) + _items = [] + if self.scenarios: + for _item_scenarios in self.scenarios: + if _item_scenarios: + _items.append(_item_scenarios.to_dict()) + _dict['scenarios'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningPlanInfoDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "displayName": obj.get("displayName"), + "modelId": obj.get("modelId"), + "scenarios": [PlanningScenarioInfoDTO.from_dict(_item) for _item in obj["scenarios"]] if obj.get("scenarios") is not None else None, + "parentPlanUuid": obj.get("parentPlanUuid"), + "currencyCode": obj.get("currencyCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_item_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_item_dto.py new file mode 100644 index 0000000000..b5b945e77f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_item_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class PlanningPlanItemDTO(BaseModel): + """ + A plan item is a metric in your plan. The available plan items depend on the planning model. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the plan item.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the plan item.", alias="displayName") + data_type: Optional[StrictStr] = Field(default=None, description="The data type of the plan item. The data types are: - **rate**: Converts values into a percentage in the planning grid. The provided value is multiplied by 100 to get the display value. For example, a provided value of 0.5 is displayed as 50% in the grid. - **number**: Displays values as whole numbers. Decimal values are rounded to a whole number when displayed in the planning grid. - **currency**: Displays values as a currency. Values must not contain thousand separators, currency codes, or currency symbols. - **decimal**: Displays values with decimals.", alias="dataType") + __properties: ClassVar[List[str]] = ["id", "displayName", "dataType"] + + @field_validator('data_type') + def data_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['unknown', 'number', 'currency', 'decimal', 'rate']): + raise ValueError("must be one of enum values ('unknown', 'number', 'currency', 'decimal', 'rate')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningPlanItemDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningPlanItemDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "dataType": obj.get("dataType") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_schema_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_schema_dto.py new file mode 100644 index 0000000000..848e7a53e9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_schema_dto.py @@ -0,0 +1,126 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.planning_plan_item_dto import PlanningPlanItemDTO +from visier_platform_sdk.models.planning_plan_segment_level_dto import PlanningPlanSegmentLevelDTO +from visier_platform_sdk.models.planning_plan_segment_level_member_list_dto import PlanningPlanSegmentLevelMemberListDTO +from visier_platform_sdk.models.planning_plan_time_period_dto import PlanningPlanTimePeriodDTO +from typing import Optional, Set +from typing_extensions import Self + +class PlanningPlanSchemaDTO(BaseModel): + """ + Information about a plan's schema. + """ # noqa: E501 + plan_items: Optional[List[PlanningPlanItemDTO]] = Field(default=None, description="A collection of editable plan items in a plan.", alias="planItems") + time_periods: Optional[List[PlanningPlanTimePeriodDTO]] = Field(default=None, description="The editable time periods in a plan. These time periods are the columns in the planning grid.", alias="timePeriods") + plan_segment_levels: Optional[List[PlanningPlanSegmentLevelDTO]] = Field(default=None, description="The dimensions that the plan is segmented by.", alias="planSegmentLevels") + plan_segment_level_members: Optional[List[PlanningPlanSegmentLevelMemberListDTO]] = Field(default=None, description="A collection of members grouped by their dimension and level. The combination of these member IDs points to a specific row in the plan.", alias="planSegmentLevelMembers") + __properties: ClassVar[List[str]] = ["planItems", "timePeriods", "planSegmentLevels", "planSegmentLevelMembers"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningPlanSchemaDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in plan_items (list) + _items = [] + if self.plan_items: + for _item_plan_items in self.plan_items: + if _item_plan_items: + _items.append(_item_plan_items.to_dict()) + _dict['planItems'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in time_periods (list) + _items = [] + if self.time_periods: + for _item_time_periods in self.time_periods: + if _item_time_periods: + _items.append(_item_time_periods.to_dict()) + _dict['timePeriods'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in plan_segment_levels (list) + _items = [] + if self.plan_segment_levels: + for _item_plan_segment_levels in self.plan_segment_levels: + if _item_plan_segment_levels: + _items.append(_item_plan_segment_levels.to_dict()) + _dict['planSegmentLevels'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in plan_segment_level_members (list) + _items = [] + if self.plan_segment_level_members: + for _item_plan_segment_level_members in self.plan_segment_level_members: + if _item_plan_segment_level_members: + _items.append(_item_plan_segment_level_members.to_dict()) + _dict['planSegmentLevelMembers'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningPlanSchemaDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "planItems": [PlanningPlanItemDTO.from_dict(_item) for _item in obj["planItems"]] if obj.get("planItems") is not None else None, + "timePeriods": [PlanningPlanTimePeriodDTO.from_dict(_item) for _item in obj["timePeriods"]] if obj.get("timePeriods") is not None else None, + "planSegmentLevels": [PlanningPlanSegmentLevelDTO.from_dict(_item) for _item in obj["planSegmentLevels"]] if obj.get("planSegmentLevels") is not None else None, + "planSegmentLevelMembers": [PlanningPlanSegmentLevelMemberListDTO.from_dict(_item) for _item in obj["planSegmentLevelMembers"]] if obj.get("planSegmentLevelMembers") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_segment_level_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_segment_level_dto.py new file mode 100644 index 0000000000..34f32ebc5e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_segment_level_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class PlanningPlanSegmentLevelDTO(BaseModel): + """ + A dimension and dimension level that segments the plan. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The symbol name of the dimension appended with its level ID.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the dimension level.", alias="displayName") + order: Optional[StrictInt] = Field(default=None, description="The number that describes the segment's position in the plan's overall structure.") + segment_id: Optional[StrictStr] = Field(default=None, description="The symbol name of the dimension.", alias="segmentId") + segment_display_name: Optional[StrictStr] = Field(default=None, description="The display name of the dimension.", alias="segmentDisplayName") + __properties: ClassVar[List[str]] = ["id", "displayName", "order", "segmentId", "segmentDisplayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningPlanSegmentLevelDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningPlanSegmentLevelDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "order": obj.get("order"), + "segmentId": obj.get("segmentId"), + "segmentDisplayName": obj.get("segmentDisplayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_segment_level_member_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_segment_level_member_dto.py new file mode 100644 index 0000000000..1ea63a2127 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_segment_level_member_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class PlanningPlanSegmentLevelMemberDTO(BaseModel): + """ + A member in the dimension. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dimension member.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the dimension member.", alias="displayName") + is_custom: Optional[StrictBool] = Field(default=None, description="If `true`, this is a custom member created for use in the plan and all its subplans.", alias="isCustom") + parent_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dimension member's parent.", alias="parentId") + __properties: ClassVar[List[str]] = ["id", "displayName", "isCustom", "parentId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningPlanSegmentLevelMemberDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningPlanSegmentLevelMemberDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "isCustom": obj.get("isCustom"), + "parentId": obj.get("parentId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_segment_level_member_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_segment_level_member_list_dto.py new file mode 100644 index 0000000000..e1273f547a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_segment_level_member_list_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.planning_plan_segment_level_member_dto import PlanningPlanSegmentLevelMemberDTO +from typing import Optional, Set +from typing_extensions import Self + +class PlanningPlanSegmentLevelMemberListDTO(BaseModel): + """ + A collection of dimension members. + """ # noqa: E501 + segment_level_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dimension and dimension level.", alias="segmentLevelId") + members: Optional[List[PlanningPlanSegmentLevelMemberDTO]] = Field(default=None, description="The dimension members.") + segment_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dimension.", alias="segmentId") + __properties: ClassVar[List[str]] = ["segmentLevelId", "members", "segmentId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningPlanSegmentLevelMemberListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in members (list) + _items = [] + if self.members: + for _item_members in self.members: + if _item_members: + _items.append(_item_members.to_dict()) + _dict['members'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningPlanSegmentLevelMemberListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "segmentLevelId": obj.get("segmentLevelId"), + "members": [PlanningPlanSegmentLevelMemberDTO.from_dict(_item) for _item in obj["members"]] if obj.get("members") is not None else None, + "segmentId": obj.get("segmentId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_time_period_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_time_period_dto.py new file mode 100644 index 0000000000..747b4d6483 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_time_period_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class PlanningPlanTimePeriodDTO(BaseModel): + """ + A time period in the plan. + """ # noqa: E501 + var_date: Optional[StrictStr] = Field(default=None, description="The date of the time period. The format is YYYY-MM-DD.", alias="date") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the time period; for example, March 2024.", alias="displayName") + __properties: ClassVar[List[str]] = ["date", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningPlanTimePeriodDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningPlanTimePeriodDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "date": obj.get("date"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_with_schema_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_with_schema_dto.py new file mode 100644 index 0000000000..5e259c41c2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_plan_with_schema_dto.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.planning_plan_data_load_error_dto import PlanningPlanDataLoadErrorDTO +from visier_platform_sdk.models.planning_plan_info_dto import PlanningPlanInfoDTO +from visier_platform_sdk.models.planning_plan_schema_dto import PlanningPlanSchemaDTO +from typing import Optional, Set +from typing_extensions import Self + +class PlanningPlanWithSchemaDTO(BaseModel): + """ + Details about the plan, including its schema. + """ # noqa: E501 + plan: Optional[PlanningPlanInfoDTO] = None + var_schema: Optional[PlanningPlanSchemaDTO] = Field(default=None, alias="schema") + errors: Optional[List[PlanningPlanDataLoadErrorDTO]] = Field(default=None, description="The errors that occurred while loading the data.") + __properties: ClassVar[List[str]] = ["plan", "schema", "errors"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningPlanWithSchemaDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of plan + if self.plan: + _dict['plan'] = self.plan.to_dict() + # override the default output from pydantic by calling `to_dict()` of var_schema + if self.var_schema: + _dict['schema'] = self.var_schema.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in errors (list) + _items = [] + if self.errors: + for _item_errors in self.errors: + if _item_errors: + _items.append(_item_errors.to_dict()) + _dict['errors'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningPlanWithSchemaDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "plan": PlanningPlanInfoDTO.from_dict(obj["plan"]) if obj.get("plan") is not None else None, + "schema": PlanningPlanSchemaDTO.from_dict(obj["schema"]) if obj.get("schema") is not None else None, + "errors": [PlanningPlanDataLoadErrorDTO.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/planning_scenario_info_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/planning_scenario_info_dto.py new file mode 100644 index 0000000000..c6b64ae085 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/planning_scenario_info_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class PlanningScenarioInfoDTO(BaseModel): + """ + Information about a plan's scenario. + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The UUID of the scenario.") + display_name: Optional[StrictStr] = Field(default=None, description="The full display name of the scenario.", alias="displayName") + versioned_scenario_id: Optional[StrictStr] = Field(default=None, description="If the scenario belongs to a managed plan, the response returns the scenario's user-readable symbol name.", alias="versionedScenarioId") + __properties: ClassVar[List[str]] = ["uuid", "displayName", "versionedScenarioId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PlanningScenarioInfoDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PlanningScenarioInfoDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "displayName": obj.get("displayName"), + "versionedScenarioId": obj.get("versionedScenarioId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmark_input.py b/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmark_input.py new file mode 100644 index 0000000000..116dee004d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmark_input.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SalaryBenchmarkInput(BaseModel): + """ + SalaryBenchmarkInput + """ # noqa: E501 + uuid: StrictStr = Field(description="A unique identifier of the individual requests. ") + job: StrictStr = Field(description="The job member ID. ") + industry: Optional[StrictStr] = Field(default=None, description="The industry member ID. If the ID is not provided, the response returns the benchmark value across all industries. ") + naics_code: Optional[StrictStr] = Field(default=None, description="The North American Industry Classification System (NAICS) code. If the NAICS code is not provided, the response returns the benchmark value across all industries. If both `naicsCode` and `industry` are provided, the response returns the benchmark value for the `industry` parameter. The entered `naicsCode` will not be applied. ", alias="naicsCode") + location: Optional[StrictStr] = Field(default=None, description="The location member ID. If the ID is not provided, the response returns the benchmark value across all locations. ") + company_size: Optional[StrictStr] = Field(default=None, description="The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes. ", alias="companySize") + career_level: Optional[StrictStr] = Field(default=None, description="The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. ", alias="careerLevel") + __properties: ClassVar[List[str]] = ["uuid", "job", "industry", "naicsCode", "location", "companySize", "careerLevel"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SalaryBenchmarkInput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SalaryBenchmarkInput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "job": obj.get("job"), + "industry": obj.get("industry"), + "naicsCode": obj.get("naicsCode"), + "location": obj.get("location"), + "companySize": obj.get("companySize"), + "careerLevel": obj.get("careerLevel") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py b/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py new file mode 100644 index 0000000000..5b3dcf4387 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SalaryBenchmarksBatchProcessingFailureOutput(BaseModel): + """ + Error description for individual requests within a bulk request. + """ # noqa: E501 + uuid: StrictStr = Field(description="A unique identifier of the individual requests. ") + http_status: StrictStr = Field(description="A three-digit code that indicates the outcome of a request. ", alias="httpStatus") + message: StrictStr = Field(description="The details of the error. ") + rci: StrictStr = Field(description="A root cause identifier that allows Visier to determine the source of the problem. ") + error_code: StrictStr = Field(description="A brief identifier of the type of error. ", alias="errorCode") + __properties: ClassVar[List[str]] = ["uuid", "httpStatus", "message", "rci", "errorCode"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SalaryBenchmarksBatchProcessingFailureOutput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SalaryBenchmarksBatchProcessingFailureOutput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "httpStatus": obj.get("httpStatus"), + "message": obj.get("message"), + "rci": obj.get("rci"), + "errorCode": obj.get("errorCode") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py b/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py new file mode 100644 index 0000000000..8cead76ebd --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.salary_benchmarks_batch_processing_failure_output import SalaryBenchmarksBatchProcessingFailureOutput +from visier_platform_sdk.models.salary_benchmarks_batch_processing_successful_output import SalaryBenchmarksBatchProcessingSuccessfulOutput +from typing import Optional, Set +from typing_extensions import Self + +class SalaryBenchmarksBatchProcessingOutputs(BaseModel): + """ + All operations in the bulk request were completed. + """ # noqa: E501 + successes: Optional[List[SalaryBenchmarksBatchProcessingSuccessfulOutput]] = None + failures: Optional[List[SalaryBenchmarksBatchProcessingFailureOutput]] = None + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SalaryBenchmarksBatchProcessingOutputs from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SalaryBenchmarksBatchProcessingOutputs from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [SalaryBenchmarksBatchProcessingSuccessfulOutput.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [SalaryBenchmarksBatchProcessingFailureOutput.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py b/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py new file mode 100644 index 0000000000..0ec72ac676 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SalaryBenchmarksBatchProcessingSuccessfulOutput(BaseModel): + """ + The compensation benchmark values for individual requests within a bulk request. + """ # noqa: E501 + uuid: StrictStr = Field(description="A unique identifier of the individual requests. ") + percentile10: StrictInt = Field(description="The 10th percentile base pay. ") + percentile25: StrictInt = Field(description="The 25th percentile base pay. ") + percentile50: StrictInt = Field(description="The 50th percentile base pay. ") + percentile75: StrictInt = Field(description="The 75th percentile base pay. ") + percentile90: StrictInt = Field(description="The 90th percentile base pay. ") + aligned_range_min: StrictInt = Field(description="The lower bound of salaries that are aligned with the market. ", alias="alignedRangeMin") + aligned_range_max: StrictInt = Field(description="The upper bound of salaries that are aligned with the market. ", alias="alignedRangeMax") + reference_date: StrictStr = Field(description="The date that benchmark values are calculated for. ", alias="referenceDate") + release_date: StrictStr = Field(description="The date that benchmark values are released. ", alias="releaseDate") + industry_id: StrictStr = Field(description="The industry member ID for the returned benchmarks. ", alias="industryId") + career_level_id: StrictStr = Field(description="The career level member ID for the returned benchmarks. ", alias="careerLevelId") + __properties: ClassVar[List[str]] = ["uuid", "percentile10", "percentile25", "percentile50", "percentile75", "percentile90", "alignedRangeMin", "alignedRangeMax", "referenceDate", "releaseDate", "industryId", "careerLevelId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SalaryBenchmarksBatchProcessingSuccessfulOutput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SalaryBenchmarksBatchProcessingSuccessfulOutput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "percentile10": obj.get("percentile10"), + "percentile25": obj.get("percentile25"), + "percentile50": obj.get("percentile50"), + "percentile75": obj.get("percentile75"), + "percentile90": obj.get("percentile90"), + "alignedRangeMin": obj.get("alignedRangeMin"), + "alignedRangeMax": obj.get("alignedRangeMax"), + "referenceDate": obj.get("referenceDate"), + "releaseDate": obj.get("releaseDate"), + "industryId": obj.get("industryId"), + "careerLevelId": obj.get("careerLevelId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_request_dto.py new file mode 100644 index 0000000000..78d83a3391 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_request_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_target_tenant_code_dto import ServicingTargetTenantCodeDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAccessibleTenantProfileAssignmentRequestDTO(BaseModel): + """ + ServicingAccessibleTenantProfileAssignmentRequestDTO + """ # noqa: E501 + target_user_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of users to assign this profile.", alias="targetUserIds") + target_tenant_codes: Optional[List[ServicingTargetTenantCodeDTO]] = Field(default=None, description="A list of objects representing the analytic tenants for profiles assigned to the users.", alias="targetTenantCodes") + validity_start_time: Optional[StrictStr] = Field(default=None, description="An inclusive date-time when this profile is active.", alias="validityStartTime") + validity_end_time: Optional[StrictStr] = Field(default=None, description="An exclusive date-time when this profile is no longer active.", alias="validityEndTime") + __properties: ClassVar[List[str]] = ["targetUserIds", "targetTenantCodes", "validityStartTime", "validityEndTime"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAccessibleTenantProfileAssignmentRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in target_tenant_codes (list) + _items = [] + if self.target_tenant_codes: + for _item_target_tenant_codes in self.target_tenant_codes: + if _item_target_tenant_codes: + _items.append(_item_target_tenant_codes.to_dict()) + _dict['targetTenantCodes'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAccessibleTenantProfileAssignmentRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "targetUserIds": obj.get("targetUserIds"), + "targetTenantCodes": [ServicingTargetTenantCodeDTO.from_dict(_item) for _item in obj["targetTenantCodes"]] if obj.get("targetTenantCodes") is not None else None, + "validityStartTime": obj.get("validityStartTime"), + "validityEndTime": obj.get("validityEndTime") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_response_dto.py new file mode 100644 index 0000000000..c58d356a4b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_response_dto.py @@ -0,0 +1,128 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_failed_accessible_tenant_profile_assignment_dto import ServicingFailedAccessibleTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_successful_accessible_tenant_profile_assignment_dto import ServicingSuccessfulAccessibleTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_tenant_code_error_dto import ServicingTenantCodeErrorDTO +from visier_platform_sdk.models.servicing_user_id_error_dto import ServicingUserIdErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAccessibleTenantProfileAssignmentResponseDTO(BaseModel): + """ + ServicingAccessibleTenantProfileAssignmentResponseDTO + """ # noqa: E501 + errors: Optional[StrictBool] = Field(default=None, description="If true, an error is generated by the request.") + bad_tenant_codes: Optional[List[ServicingTenantCodeErrorDTO]] = Field(default=None, description="A list of objects representing any tenants that returned errors.", alias="badTenantCodes") + bad_user_ids: Optional[List[ServicingUserIdErrorDTO]] = Field(default=None, description="A list of objects representing the user IDs that may not be valid.", alias="badUserIds") + failed_assignments: Optional[List[ServicingFailedAccessibleTenantProfileAssignmentDTO]] = Field(default=None, description="A list of objects representing any errors during the assignment operation.", alias="failedAssignments") + successful_assignments: Optional[List[ServicingSuccessfulAccessibleTenantProfileAssignmentDTO]] = Field(default=None, description="A list of user IDs that were successfully assigned the profiles.", alias="successfulAssignments") + __properties: ClassVar[List[str]] = ["errors", "badTenantCodes", "badUserIds", "failedAssignments", "successfulAssignments"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAccessibleTenantProfileAssignmentResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in bad_tenant_codes (list) + _items = [] + if self.bad_tenant_codes: + for _item_bad_tenant_codes in self.bad_tenant_codes: + if _item_bad_tenant_codes: + _items.append(_item_bad_tenant_codes.to_dict()) + _dict['badTenantCodes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in bad_user_ids (list) + _items = [] + if self.bad_user_ids: + for _item_bad_user_ids in self.bad_user_ids: + if _item_bad_user_ids: + _items.append(_item_bad_user_ids.to_dict()) + _dict['badUserIds'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failed_assignments (list) + _items = [] + if self.failed_assignments: + for _item_failed_assignments in self.failed_assignments: + if _item_failed_assignments: + _items.append(_item_failed_assignments.to_dict()) + _dict['failedAssignments'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in successful_assignments (list) + _items = [] + if self.successful_assignments: + for _item_successful_assignments in self.successful_assignments: + if _item_successful_assignments: + _items.append(_item_successful_assignments.to_dict()) + _dict['successfulAssignments'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAccessibleTenantProfileAssignmentResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "errors": obj.get("errors"), + "badTenantCodes": [ServicingTenantCodeErrorDTO.from_dict(_item) for _item in obj["badTenantCodes"]] if obj.get("badTenantCodes") is not None else None, + "badUserIds": [ServicingUserIdErrorDTO.from_dict(_item) for _item in obj["badUserIds"]] if obj.get("badUserIds") is not None else None, + "failedAssignments": [ServicingFailedAccessibleTenantProfileAssignmentDTO.from_dict(_item) for _item in obj["failedAssignments"]] if obj.get("failedAssignments") is not None else None, + "successfulAssignments": [ServicingSuccessfulAccessibleTenantProfileAssignmentDTO.from_dict(_item) for _item in obj["successfulAssignments"]] if obj.get("successfulAssignments") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_request_dto.py new file mode 100644 index 0000000000..db74fae202 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_request_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_target_tenant_code_dto import ServicingTargetTenantCodeDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAccessibleTenantProfileRevokeRequestDTO(BaseModel): + """ + ServicingAccessibleTenantProfileRevokeRequestDTO + """ # noqa: E501 + target_user_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of users to remove this profile from.", alias="targetUserIds") + target_tenant_codes: Optional[List[ServicingTargetTenantCodeDTO]] = Field(default=None, description="A list of objects representing the analytic tenants for removing profiles from each target user ID.", alias="targetTenantCodes") + __properties: ClassVar[List[str]] = ["targetUserIds", "targetTenantCodes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAccessibleTenantProfileRevokeRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in target_tenant_codes (list) + _items = [] + if self.target_tenant_codes: + for _item_target_tenant_codes in self.target_tenant_codes: + if _item_target_tenant_codes: + _items.append(_item_target_tenant_codes.to_dict()) + _dict['targetTenantCodes'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAccessibleTenantProfileRevokeRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "targetUserIds": obj.get("targetUserIds"), + "targetTenantCodes": [ServicingTargetTenantCodeDTO.from_dict(_item) for _item in obj["targetTenantCodes"]] if obj.get("targetTenantCodes") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_response_dto.py new file mode 100644 index 0000000000..bd443ac0a3 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_response_dto.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_reduced_tenant_code_error_dto import ServicingReducedTenantCodeErrorDTO +from visier_platform_sdk.models.servicing_reduced_user_id_error_dto import ServicingReducedUserIdErrorDTO +from visier_platform_sdk.models.servicing_successful_local_tenant_profile_assignment_dto import ServicingSuccessfulLocalTenantProfileAssignmentDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAccessibleTenantProfileRevokeResponseDTO(BaseModel): + """ + ServicingAccessibleTenantProfileRevokeResponseDTO + """ # noqa: E501 + bad_tenant_codes: Optional[List[ServicingReducedTenantCodeErrorDTO]] = Field(default=None, description="A list of objects representing any tenants that returned errors.", alias="badTenantCodes") + bad_user_ids: Optional[List[ServicingReducedUserIdErrorDTO]] = Field(default=None, description="A list of objects representing the user IDs that may not be valid.", alias="badUserIds") + unaffected_users: Optional[List[ServicingSuccessfulLocalTenantProfileAssignmentDTO]] = Field(default=None, description="A list of objects representing the valid user IDs that were not affected.", alias="unaffectedUsers") + succeeded: Optional[List[ServicingSuccessfulLocalTenantProfileAssignmentDTO]] = Field(default=None, description="A list of objects representing the valid user IDs that succeeded.") + __properties: ClassVar[List[str]] = ["badTenantCodes", "badUserIds", "unaffectedUsers", "succeeded"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAccessibleTenantProfileRevokeResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in bad_tenant_codes (list) + _items = [] + if self.bad_tenant_codes: + for _item_bad_tenant_codes in self.bad_tenant_codes: + if _item_bad_tenant_codes: + _items.append(_item_bad_tenant_codes.to_dict()) + _dict['badTenantCodes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in bad_user_ids (list) + _items = [] + if self.bad_user_ids: + for _item_bad_user_ids in self.bad_user_ids: + if _item_bad_user_ids: + _items.append(_item_bad_user_ids.to_dict()) + _dict['badUserIds'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in unaffected_users (list) + _items = [] + if self.unaffected_users: + for _item_unaffected_users in self.unaffected_users: + if _item_unaffected_users: + _items.append(_item_unaffected_users.to_dict()) + _dict['unaffectedUsers'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in succeeded (list) + _items = [] + if self.succeeded: + for _item_succeeded in self.succeeded: + if _item_succeeded: + _items.append(_item_succeeded.to_dict()) + _dict['succeeded'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAccessibleTenantProfileRevokeResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "badTenantCodes": [ServicingReducedTenantCodeErrorDTO.from_dict(_item) for _item in obj["badTenantCodes"]] if obj.get("badTenantCodes") is not None else None, + "badUserIds": [ServicingReducedUserIdErrorDTO.from_dict(_item) for _item in obj["badUserIds"]] if obj.get("badUserIds") is not None else None, + "unaffectedUsers": [ServicingSuccessfulLocalTenantProfileAssignmentDTO.from_dict(_item) for _item in obj["unaffectedUsers"]] if obj.get("unaffectedUsers") is not None else None, + "succeeded": [ServicingSuccessfulLocalTenantProfileAssignmentDTO.from_dict(_item) for _item in obj["succeeded"]] if obj.get("succeeded") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_additional_capabilities_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_additional_capabilities_dto.py new file mode 100644 index 0000000000..316dad297d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_additional_capabilities_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAdditionalCapabilitiesDTO(BaseModel): + """ + ServicingAdditionalCapabilitiesDTO + """ # noqa: E501 + additional_capabilities: Optional[List[StrictStr]] = Field(default=None, description="The additional capabilities assigned to this profile.", alias="additionalCapabilities") + __properties: ClassVar[List[str]] = ["additionalCapabilities"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAdditionalCapabilitiesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAdditionalCapabilitiesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "additionalCapabilities": obj.get("additionalCapabilities") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_admin_capability_config_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_admin_capability_config_dto.py new file mode 100644 index 0000000000..c3329d44ed --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_admin_capability_config_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAdminCapabilityConfigDTO(BaseModel): + """ + ServicingAdminCapabilityConfigDTO + """ # noqa: E501 + all_capabilities_access: Optional[StrictBool] = Field(default=None, description="If `true`, the permission has all possible capabilities.", alias="allCapabilitiesAccess") + capabilities: Optional[List[StrictStr]] = Field(default=None, description="A list of the capabilities assigned in the permission. Not required if `allCapabilitiesAccess` is true.") + __properties: ClassVar[List[str]] = ["allCapabilitiesAccess", "capabilities"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAdminCapabilityConfigDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAdminCapabilityConfigDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "allCapabilitiesAccess": obj.get("allCapabilitiesAccess"), + "capabilities": obj.get("capabilities") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_permissions_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_permissions_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..08c2f7bb0c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_permissions_assigned_for_local_tenant_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_permission_assigned_for_local_tenant_dto import ServicingPermissionAssignedForLocalTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAllPermissionsAssignedForLocalTenantDTO(BaseModel): + """ + ServicingAllPermissionsAssignedForLocalTenantDTO + """ # noqa: E501 + assigned_permissions: Optional[List[ServicingPermissionAssignedForLocalTenantDTO]] = Field(default=None, description="A list of objects representing the user's permissions.", alias="assignedPermissions") + __properties: ClassVar[List[str]] = ["assignedPermissions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAllPermissionsAssignedForLocalTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in assigned_permissions (list) + _items = [] + if self.assigned_permissions: + for _item_assigned_permissions in self.assigned_permissions: + if _item_assigned_permissions: + _items.append(_item_assigned_permissions.to_dict()) + _dict['assignedPermissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAllPermissionsAssignedForLocalTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignedPermissions": [ServicingPermissionAssignedForLocalTenantDTO.from_dict(_item) for _item in obj["assignedPermissions"]] if obj.get("assignedPermissions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_profile_assigned_for_accessible_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_profile_assigned_for_accessible_tenant_dto.py new file mode 100644 index 0000000000..44d42d5279 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_profile_assigned_for_accessible_tenant_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_profile_assigned_for_accessible_tenant_dto import ServicingProfileAssignedForAccessibleTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAllProfileAssignedForAccessibleTenantDTO(BaseModel): + """ + ServicingAllProfileAssignedForAccessibleTenantDTO + """ # noqa: E501 + assigned_profiles_for_accessible_tenant: Optional[List[ServicingProfileAssignedForAccessibleTenantDTO]] = Field(default=None, description="A list of objects representing the user profiles assigned to the user and their validity range.", alias="assignedProfilesForAccessibleTenant") + __properties: ClassVar[List[str]] = ["assignedProfilesForAccessibleTenant"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAllProfileAssignedForAccessibleTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in assigned_profiles_for_accessible_tenant (list) + _items = [] + if self.assigned_profiles_for_accessible_tenant: + for _item_assigned_profiles_for_accessible_tenant in self.assigned_profiles_for_accessible_tenant: + if _item_assigned_profiles_for_accessible_tenant: + _items.append(_item_assigned_profiles_for_accessible_tenant.to_dict()) + _dict['assignedProfilesForAccessibleTenant'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAllProfileAssignedForAccessibleTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignedProfilesForAccessibleTenant": [ServicingProfileAssignedForAccessibleTenantDTO.from_dict(_item) for _item in obj["assignedProfilesForAccessibleTenant"]] if obj.get("assignedProfilesForAccessibleTenant") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_profile_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_profile_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..85f7a2c0b3 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_profile_assigned_for_local_tenant_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_profile_assigned_for_local_tenant_dto import ServicingProfileAssignedForLocalTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAllProfileAssignedForLocalTenantDTO(BaseModel): + """ + ServicingAllProfileAssignedForLocalTenantDTO + """ # noqa: E501 + assigned_profiles: Optional[List[ServicingProfileAssignedForLocalTenantDTO]] = Field(default=None, description="A list of objects representing the user profiles assigned to the user and their validity range.", alias="assignedProfiles") + __properties: ClassVar[List[str]] = ["assignedProfiles"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAllProfileAssignedForLocalTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in assigned_profiles (list) + _items = [] + if self.assigned_profiles: + for _item_assigned_profiles in self.assigned_profiles: + if _item_assigned_profiles: + _items.append(_item_assigned_profiles.to_dict()) + _dict['assignedProfiles'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAllProfileAssignedForLocalTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignedProfiles": [ServicingProfileAssignedForLocalTenantDTO.from_dict(_item) for _item in obj["assignedProfiles"]] if obj.get("assignedProfiles") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_user_groups_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_user_groups_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..7195d4de67 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_user_groups_assigned_for_local_tenant_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_user_group_assigned_for_local_tenant_dto import ServicingUserGroupAssignedForLocalTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAllUserGroupsAssignedForLocalTenantDTO(BaseModel): + """ + ServicingAllUserGroupsAssignedForLocalTenantDTO + """ # noqa: E501 + assigned_user_groups: Optional[List[ServicingUserGroupAssignedForLocalTenantDTO]] = Field(default=None, description="A list of objects representing the available user groups.", alias="assignedUserGroups") + __properties: ClassVar[List[str]] = ["assignedUserGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAllUserGroupsAssignedForLocalTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in assigned_user_groups (list) + _items = [] + if self.assigned_user_groups: + for _item_assigned_user_groups in self.assigned_user_groups: + if _item_assigned_user_groups: + _items.append(_item_assigned_user_groups.to_dict()) + _dict['assignedUserGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAllUserGroupsAssignedForLocalTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "assignedUserGroups": [ServicingUserGroupAssignedForLocalTenantDTO.from_dict(_item) for _item in obj["assignedUserGroups"]] if obj.get("assignedUserGroups") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_users_get_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_users_get_api_response_dto.py new file mode 100644 index 0000000000..ac38769e33 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_all_users_get_api_response_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_user_get_api_response_dto import ServicingUserGetAPIResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAllUsersGetAPIResponseDTO(BaseModel): + """ + ServicingAllUsersGetAPIResponseDTO + """ # noqa: E501 + users: Optional[List[ServicingUserGetAPIResponseDTO]] = Field(default=None, description="A list of available users.") + limit: Optional[StrictInt] = Field(default=None, description="The number of results to return. The maximum number of users to retrieve is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving results from, also known as offset. The index begins at 0.") + __properties: ClassVar[List[str]] = ["users", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAllUsersGetAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAllUsersGetAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "users": [ServicingUserGetAPIResponseDTO.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_analytic_object_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_analytic_object_dto.py new file mode 100644 index 0000000000..0c0c9f5dc9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_analytic_object_dto.py @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_related_analytic_object_dto import ServicingRelatedAnalyticObjectDTO +from visier_platform_sdk.models.servicing_securable_dimension_dto import ServicingSecurableDimensionDTO +from visier_platform_sdk.models.servicing_securable_property_dto import ServicingSecurablePropertyDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAnalyticObjectDTO(BaseModel): + """ + ServicingAnalyticObjectDTO + """ # noqa: E501 + analytic_object_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analytic object.", alias="analyticObjectId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name to display in Visier, such as \"Employee\".", alias="displayName") + object_type: Optional[StrictStr] = Field(default=None, description="The analytic object type.", alias="objectType") + related_objects: Optional[List[ServicingRelatedAnalyticObjectDTO]] = Field(default=None, description="The analytic objects related to the data security object.", alias="relatedObjects") + securable_properties: Optional[List[ServicingSecurablePropertyDTO]] = Field(default=None, description="All available properties from the data security object and its related analytic objects that you can configure data access for.", alias="securableProperties") + securable_dimensions: Optional[List[ServicingSecurableDimensionDTO]] = Field(default=None, description="A list of dimensions that are available to define population access filters in the permission.", alias="securableDimensions") + __properties: ClassVar[List[str]] = ["analyticObjectId", "displayName", "objectType", "relatedObjects", "securableProperties", "securableDimensions"] + + @field_validator('object_type') + def object_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Event', 'Subject', 'BusinessOutcomeOverlay', 'PlanOrBudgetOverlay', 'ExternalBenchmark', 'VisierBenchmark', 'UsageOverlay', 'OtherOverlay', 'InternalComparison', 'PlanAnalyticObject']): + raise ValueError("must be one of enum values ('Event', 'Subject', 'BusinessOutcomeOverlay', 'PlanOrBudgetOverlay', 'ExternalBenchmark', 'VisierBenchmark', 'UsageOverlay', 'OtherOverlay', 'InternalComparison', 'PlanAnalyticObject')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAnalyticObjectDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in related_objects (list) + _items = [] + if self.related_objects: + for _item_related_objects in self.related_objects: + if _item_related_objects: + _items.append(_item_related_objects.to_dict()) + _dict['relatedObjects'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in securable_properties (list) + _items = [] + if self.securable_properties: + for _item_securable_properties in self.securable_properties: + if _item_securable_properties: + _items.append(_item_securable_properties.to_dict()) + _dict['securableProperties'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in securable_dimensions (list) + _items = [] + if self.securable_dimensions: + for _item_securable_dimensions in self.securable_dimensions: + if _item_securable_dimensions: + _items.append(_item_securable_dimensions.to_dict()) + _dict['securableDimensions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAnalyticObjectDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjectId": obj.get("analyticObjectId"), + "displayName": obj.get("displayName"), + "objectType": obj.get("objectType"), + "relatedObjects": [ServicingRelatedAnalyticObjectDTO.from_dict(_item) for _item in obj["relatedObjects"]] if obj.get("relatedObjects") is not None else None, + "securableProperties": [ServicingSecurablePropertyDTO.from_dict(_item) for _item in obj["securableProperties"]] if obj.get("securableProperties") is not None else None, + "securableDimensions": [ServicingSecurableDimensionDTO.from_dict(_item) for _item in obj["securableDimensions"]] if obj.get("securableDimensions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_by_permission_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_by_permission_dto.py new file mode 100644 index 0000000000..df94fa51d4 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_by_permission_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_user_dto import ServicingAssignRevokePermissionByUserDTO +from visier_platform_sdk.models.servicing_permission_assigned_for_local_tenant_dto import ServicingPermissionAssignedForLocalTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAssignRevokePermissionByPermissionDTO(BaseModel): + """ + The results of the permission assignment or removal. + """ # noqa: E501 + permission: Optional[ServicingPermissionAssignedForLocalTenantDTO] = None + users: Optional[List[ServicingAssignRevokePermissionByUserDTO]] = Field(default=None, description="A list of objects representing the users that was permission was assigned to or removed from.") + __properties: ClassVar[List[str]] = ["permission", "users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionByPermissionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of permission + if self.permission: + _dict['permission'] = self.permission.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionByPermissionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permission": ServicingPermissionAssignedForLocalTenantDTO.from_dict(obj["permission"]) if obj.get("permission") is not None else None, + "users": [ServicingAssignRevokePermissionByUserDTO.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_by_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_by_tenant_dto.py new file mode 100644 index 0000000000..eab59c0589 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_by_tenant_dto.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_permission_dto import ServicingAssignRevokePermissionByPermissionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAssignRevokePermissionByTenantDTO(BaseModel): + """ + The permissions organized by tenant. + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the tenant.", alias="tenantCode") + permissions: Optional[List[ServicingAssignRevokePermissionByPermissionDTO]] = Field(default=None, description="A list of objects representing the assigned or removed permissions.") + status: Optional[StrictStr] = Field(default=None, description="The state of the permission assignment. Valid values are Succeed or Failed.") + message: Optional[StrictStr] = Field(default=None, description="A detailed description of the request outcome, if available.") + project_id: Optional[StrictStr] = Field(default=None, description="The ID of the project that the change was made in, if applicable.", alias="projectId") + __properties: ClassVar[List[str]] = ["tenantCode", "permissions", "status", "message", "projectId"] + + @field_validator('status') + def status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unknown', 'Succeed', 'Failed']): + raise ValueError("must be one of enum values ('Unknown', 'Succeed', 'Failed')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionByTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionByTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "permissions": [ServicingAssignRevokePermissionByPermissionDTO.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None, + "status": obj.get("status"), + "message": obj.get("message"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_by_user_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_by_user_dto.py new file mode 100644 index 0000000000..968292cc11 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_by_user_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAssignRevokePermissionByUserDTO(BaseModel): + """ + The results of the permission assignment or removal by user. + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user.", alias="userId") + username: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@visier.com.") + message: Optional[StrictStr] = Field(default=None, description="A meaningful message about the user permission.") + __properties: ClassVar[List[str]] = ["userId", "username", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionByUserDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionByUserDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "username": obj.get("username"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_request_dto.py new file mode 100644 index 0000000000..c20cd730a2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permission_request_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAssignRevokePermissionRequestDTO(BaseModel): + """ + Set permission detail permissionId with assign to userIds + """ # noqa: E501 + permission_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with a permission.", alias="permissionId") + user_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing unique user IDs.", alias="userIds") + __properties: ClassVar[List[str]] = ["permissionId", "userIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissionId": obj.get("permissionId"), + "userIds": obj.get("userIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permissions_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permissions_request_dto.py new file mode 100644 index 0000000000..4a316fdf89 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permissions_request_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.admin_target_project_for_tenants_list_dto import AdminTargetProjectForTenantsListDTO +from visier_platform_sdk.models.servicing_assign_revoke_permission_request_dto import ServicingAssignRevokePermissionRequestDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAssignRevokePermissionsRequestDTO(BaseModel): + """ + Set permissions request List of permissionId with assign to user Ids + """ # noqa: E501 + permissions: Optional[List[ServicingAssignRevokePermissionRequestDTO]] = Field(default=None, description="A list of objects representing the permissions to assign to or remove from users.") + target_project_for_tenants_list: Optional[AdminTargetProjectForTenantsListDTO] = Field(default=None, description="Administrating tenants can specify the tenants and projects in which to assign permissions to users or remove permissions from users. Specify one `projectId` per `tenantCode`. If omitted, the request is immediately published to production or applied to the `ProjectID` in the request header, if available, for the administrating tenant or TargetTenantID, if available.", alias="targetProjectForTenantsList") + __properties: ClassVar[List[str]] = ["permissions", "targetProjectForTenantsList"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionsRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + # override the default output from pydantic by calling `to_dict()` of target_project_for_tenants_list + if self.target_project_for_tenants_list: + _dict['targetProjectForTenantsList'] = self.target_project_for_tenants_list.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionsRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": [ServicingAssignRevokePermissionRequestDTO.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None, + "targetProjectForTenantsList": AdminTargetProjectForTenantsListDTO.from_dict(obj["targetProjectForTenantsList"]) if obj.get("targetProjectForTenantsList") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permissions_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permissions_response_dto.py new file mode 100644 index 0000000000..dc480a1db9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_assign_revoke_permissions_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_assign_revoke_permission_by_tenant_dto import ServicingAssignRevokePermissionByTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingAssignRevokePermissionsResponseDTO(BaseModel): + """ + The results of the permission assignment or removal. + """ # noqa: E501 + tenants: Optional[List[ServicingAssignRevokePermissionByTenantDTO]] = Field(default=None, description="A list of objects representing the users that were assigned permissions, organized by the tenants the users belong to.") + __properties: ClassVar[List[str]] = ["tenants"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionsResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingAssignRevokePermissionsResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [ServicingAssignRevokePermissionByTenantDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_bulk_data_access_set_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_bulk_data_access_set_response_dto.py new file mode 100644 index 0000000000..6fbe00a9ac --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_bulk_data_access_set_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_data_access_set_failure_dto import ServicingDataAccessSetFailureDTO +from visier_platform_sdk.models.servicing_data_access_set_success_dto import ServicingDataAccessSetSuccessDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingBulkDataAccessSetResponseDTO(BaseModel): + """ + ServicingBulkDataAccessSetResponseDTO + """ # noqa: E501 + successes: Optional[List[ServicingDataAccessSetSuccessDTO]] = Field(default=None, description="The successfully created data access sets.") + failures: Optional[List[ServicingDataAccessSetFailureDTO]] = Field(default=None, description="The data access sets that failed to be created and any relevant error information.") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingBulkDataAccessSetResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingBulkDataAccessSetResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [ServicingDataAccessSetSuccessDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [ServicingDataAccessSetFailureDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_capabilities_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_capabilities_dto.py new file mode 100644 index 0000000000..e5572eedb8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_capabilities_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingCapabilitiesDTO(BaseModel): + """ + ServicingCapabilitiesDTO + """ # noqa: E501 + capability: Optional[StrictStr] = Field(default=None, description="The name of the capability.") + access_level: Optional[StrictStr] = Field(default=None, description="The access level of the profile for the given capability.", alias="accessLevel") + view_level: Optional[StrictStr] = Field(default=None, description="The view level of the profile for the given capability.", alias="viewLevel") + __properties: ClassVar[List[str]] = ["capability", "accessLevel", "viewLevel"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingCapabilitiesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingCapabilitiesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "capability": obj.get("capability"), + "accessLevel": obj.get("accessLevel"), + "viewLevel": obj.get("viewLevel") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_capability_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_capability_dto.py new file mode 100644 index 0000000000..660df8668d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_capability_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingCapabilityDTO(BaseModel): + """ + ServicingCapabilityDTO + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The unique name of the capability.") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable capability name to display in Visier, such as \"Schedule Analysis\".", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="A description of the capability.") + __properties: ClassVar[List[str]] = ["name", "displayName", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingCapabilityDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingCapabilityDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "displayName": obj.get("displayName"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_capability_group_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_capability_group_dto.py new file mode 100644 index 0000000000..2fd74108c2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_capability_group_dto.py @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingCapabilityGroupDTO(BaseModel): + """ + ServicingCapabilityGroupDTO + """ # noqa: E501 + group: Optional[StrictStr] = None + access_level: Optional[StrictStr] = Field(default=None, alias="accessLevel") + view_level: Optional[StrictStr] = Field(default=None, alias="viewLevel") + api_access_level: Optional[StrictStr] = Field(default=None, alias="apiAccessLevel") + api_view_level: Optional[StrictStr] = Field(default=None, alias="apiViewLevel") + __properties: ClassVar[List[str]] = ["group", "accessLevel", "viewLevel", "apiAccessLevel", "apiViewLevel"] + + @field_validator('group') + def group_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['unknown', 'Any', 'NotRequired', 'Data', 'Application', 'ApplicationManagement', 'Security', 'UserManagement', 'Model', 'TenantManagement', 'Settings', 'DataUpload', 'FileSharing', 'Approve', 'TwoStepPublish', 'DirectPublish', 'TenantPreview', 'OpenAPI', 'OpenPlatform', 'ManageJobs', 'SupportPowerUser', 'LMSPowerUser', 'SupportProjectManager', 'SupportStandardUser', 'Translation', 'ModuleManagement', 'AnalyticObjectCreation', 'ClassicAdminConfig', 'ClassicReadOnlyAdminConfig', 'ClassicManageTenant', 'ClassicAnalysis', 'ClassicDraft', 'ClassicInternalDebugging', 'ClassicAPIRestricted', 'InfrastructureOperations', 'SolutionDesigner', 'AccessToAllData', 'FeatureToggle', 'SystemDiagnostics', 'SystemDiagnosticsSensitive', 'ConsumptionPricingAdmin', 'ReadImpersonator', 'WriteImpersonator', 'ReadImpersonated', 'WriteImpersonated', 'MasterImpersonator', 'Impersonator', 'WillowUser', 'WillowAdmin', 'GeminiManager', 'GeminiSupport', 'GeminiAdmin', 'GeminiSysAdmin', 'ConsolidatedAnalytics', 'RequestSecureTicket', 'RequestAuthToken', 'OAuth2ClientRegistration', 'AccessToAllProperties', 'AccessToKeyProperties', 'PlanningManagement', 'WillowVantageCrawler', 'DataValidation', 'ContentReassignment', 'ReportDownloading', 'PlutoUser', 'ReportingManagement', 'QuotaManagement', 'WebhookManagement', 'ProfileManagement', 'UserGroupManagement', 'ProactiveAlertManagement']): + raise ValueError("must be one of enum values ('unknown', 'Any', 'NotRequired', 'Data', 'Application', 'ApplicationManagement', 'Security', 'UserManagement', 'Model', 'TenantManagement', 'Settings', 'DataUpload', 'FileSharing', 'Approve', 'TwoStepPublish', 'DirectPublish', 'TenantPreview', 'OpenAPI', 'OpenPlatform', 'ManageJobs', 'SupportPowerUser', 'LMSPowerUser', 'SupportProjectManager', 'SupportStandardUser', 'Translation', 'ModuleManagement', 'AnalyticObjectCreation', 'ClassicAdminConfig', 'ClassicReadOnlyAdminConfig', 'ClassicManageTenant', 'ClassicAnalysis', 'ClassicDraft', 'ClassicInternalDebugging', 'ClassicAPIRestricted', 'InfrastructureOperations', 'SolutionDesigner', 'AccessToAllData', 'FeatureToggle', 'SystemDiagnostics', 'SystemDiagnosticsSensitive', 'ConsumptionPricingAdmin', 'ReadImpersonator', 'WriteImpersonator', 'ReadImpersonated', 'WriteImpersonated', 'MasterImpersonator', 'Impersonator', 'WillowUser', 'WillowAdmin', 'GeminiManager', 'GeminiSupport', 'GeminiAdmin', 'GeminiSysAdmin', 'ConsolidatedAnalytics', 'RequestSecureTicket', 'RequestAuthToken', 'OAuth2ClientRegistration', 'AccessToAllProperties', 'AccessToKeyProperties', 'PlanningManagement', 'WillowVantageCrawler', 'DataValidation', 'ContentReassignment', 'ReportDownloading', 'PlutoUser', 'ReportingManagement', 'QuotaManagement', 'WebhookManagement', 'ProfileManagement', 'UserGroupManagement', 'ProactiveAlertManagement')") + return value + + @field_validator('access_level') + def access_level_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['NoAccess', 'ReadOnly', 'Write']): + raise ValueError("must be one of enum values ('NoAccess', 'ReadOnly', 'Write')") + return value + + @field_validator('view_level') + def view_level_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Simple', 'Detailed', 'API', 'Certified', 'Embedded']): + raise ValueError("must be one of enum values ('Simple', 'Detailed', 'API', 'Certified', 'Embedded')") + return value + + @field_validator('api_access_level') + def api_access_level_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['NoAccess', 'ReadOnly', 'Write']): + raise ValueError("must be one of enum values ('NoAccess', 'ReadOnly', 'Write')") + return value + + @field_validator('api_view_level') + def api_view_level_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Simple', 'Detailed', 'API', 'Certified', 'Embedded']): + raise ValueError("must be one of enum values ('Simple', 'Detailed', 'API', 'Certified', 'Embedded')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingCapabilityGroupDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingCapabilityGroupDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "group": obj.get("group"), + "accessLevel": obj.get("accessLevel"), + "viewLevel": obj.get("viewLevel"), + "apiAccessLevel": obj.get("apiAccessLevel"), + "apiViewLevel": obj.get("apiViewLevel") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_commit_and_publish_operation_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_commit_and_publish_operation_response_dto.py new file mode 100644 index 0000000000..ae77dfbe55 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_commit_and_publish_operation_response_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_project_dto import ServicingProjectDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingCommitAndPublishOperationResponseDTO(BaseModel): + """ + ServicingCommitAndPublishOperationResponseDTO + """ # noqa: E501 + published_version: Optional[ServicingProjectDTO] = Field(default=None, description="The project version that was published to production.", alias="publishedVersion") + __properties: ClassVar[List[str]] = ["publishedVersion"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingCommitAndPublishOperationResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of published_version + if self.published_version: + _dict['publishedVersion'] = self.published_version.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingCommitAndPublishOperationResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "publishedVersion": ServicingProjectDTO.from_dict(obj["publishedVersion"]) if obj.get("publishedVersion") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_commit_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_commit_dto.py new file mode 100644 index 0000000000..fb787ce5cf --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_commit_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingCommitDTO(BaseModel): + """ + ServicingCommitDTO + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the committed change.") + name: Optional[StrictStr] = Field(default=None, description="An identifiable name of the committed change to display in Visier.") + description: Optional[StrictStr] = Field(default=None, description="A description of the committed change.") + __properties: ClassVar[List[str]] = ["id", "name", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingCommitDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingCommitDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_content_package_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_content_package_dto.py new file mode 100644 index 0000000000..1baf7ce7aa --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_content_package_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingContentPackageDTO(BaseModel): + """ + ServicingContentPackageDTO + """ # noqa: E501 + content_package_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the content package.", alias="contentPackageId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable content package name to display in Visier, such as \"Talent Acquisition Core Content\".", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="A description of the content package.") + __properties: ClassVar[List[str]] = ["contentPackageId", "displayName", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingContentPackageDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingContentPackageDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "contentPackageId": obj.get("contentPackageId"), + "displayName": obj.get("displayName"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_create_data_access_set_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_create_data_access_set_request_dto.py new file mode 100644 index 0000000000..229afa62ad --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_create_data_access_set_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_data_access_set_dto import ServicingDataAccessSetDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingCreateDataAccessSetRequestDTO(BaseModel): + """ + ServicingCreateDataAccessSetRequestDTO + """ # noqa: E501 + shareable_property_access_configs: Optional[List[ServicingDataAccessSetDTO]] = Field(default=None, description="The data access sets to be created.", alias="shareablePropertyAccessConfigs") + __properties: ClassVar[List[str]] = ["shareablePropertyAccessConfigs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingCreateDataAccessSetRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in shareable_property_access_configs (list) + _items = [] + if self.shareable_property_access_configs: + for _item_shareable_property_access_configs in self.shareable_property_access_configs: + if _item_shareable_property_access_configs: + _items.append(_item_shareable_property_access_configs.to_dict()) + _dict['shareablePropertyAccessConfigs'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingCreateDataAccessSetRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "shareablePropertyAccessConfigs": [ServicingDataAccessSetDTO.from_dict(_item) for _item in obj["shareablePropertyAccessConfigs"]] if obj.get("shareablePropertyAccessConfigs") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_dto.py new file mode 100644 index 0000000000..690db509d8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_dto.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_property_access_config_dto import ServicingPropertyAccessConfigDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDataAccessSetDTO(BaseModel): + """ + ServicingDataAccessSetDTO + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the data access set.") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable data access set name to display in Visier, such as \"Aggregate(Employee)\".", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="A description of the data access set.") + analytic_object_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analytic object that the data access set is for.", alias="analyticObjectId") + property_access_configs: Optional[List[ServicingPropertyAccessConfigDTO]] = Field(default=None, description="The data access assigned to properties in the data access set.", alias="propertyAccessConfigs") + __properties: ClassVar[List[str]] = ["id", "displayName", "description", "analyticObjectId", "propertyAccessConfigs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDataAccessSetDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in property_access_configs (list) + _items = [] + if self.property_access_configs: + for _item_property_access_configs in self.property_access_configs: + if _item_property_access_configs: + _items.append(_item_property_access_configs.to_dict()) + _dict['propertyAccessConfigs'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDataAccessSetDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "analyticObjectId": obj.get("analyticObjectId"), + "propertyAccessConfigs": [ServicingPropertyAccessConfigDTO.from_dict(_item) for _item in obj["propertyAccessConfigs"]] if obj.get("propertyAccessConfigs") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_error_dto.py new file mode 100644 index 0000000000..3a88cf6fc8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_error_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDataAccessSetErrorDTO(BaseModel): + """ + ServicingDataAccessSetErrorDTO + """ # noqa: E501 + message: Optional[StrictStr] = Field(default=None, description="Error message") + rci: Optional[StrictStr] = Field(default=None, description="A root cause identifier that allows Visier to determine the source of the problem.") + __properties: ClassVar[List[str]] = ["message", "rci"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDataAccessSetErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDataAccessSetErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "rci": obj.get("rci") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_failure_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_failure_dto.py new file mode 100644 index 0000000000..cfd9a18565 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_failure_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_data_access_set_error_dto import ServicingDataAccessSetErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDataAccessSetFailureDTO(BaseModel): + """ + ServicingDataAccessSetFailureDTO + """ # noqa: E501 + data_access_set_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the data access set.", alias="dataAccessSetId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable data access set name to display in Visier, such as \"Detailed(Employee)\".", alias="displayName") + error: Optional[ServicingDataAccessSetErrorDTO] = Field(default=None, description="The error associated with the failure.") + __properties: ClassVar[List[str]] = ["dataAccessSetId", "displayName", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDataAccessSetFailureDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of error + if self.error: + _dict['error'] = self.error.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDataAccessSetFailureDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataAccessSetId": obj.get("dataAccessSetId"), + "displayName": obj.get("displayName"), + "error": ServicingDataAccessSetErrorDTO.from_dict(obj["error"]) if obj.get("error") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_success_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_success_dto.py new file mode 100644 index 0000000000..01297b556d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_access_set_success_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDataAccessSetSuccessDTO(BaseModel): + """ + ServicingDataAccessSetSuccessDTO + """ # noqa: E501 + data_access_set_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the created data access set.", alias="dataAccessSetId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable data access set name to display in Visier, such as \"Detailed(Employee)\".", alias="displayName") + __properties: ClassVar[List[str]] = ["dataAccessSetId", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDataAccessSetSuccessDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDataAccessSetSuccessDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataAccessSetId": obj.get("dataAccessSetId"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_categories_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_categories_response_dto.py new file mode 100644 index 0000000000..1a534892ab --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_categories_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_data_category_response_dto import ServicingDataCategoryResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDataCategoriesResponseDTO(BaseModel): + """ + A list of data categories. + """ # noqa: E501 + categories: Optional[List[ServicingDataCategoryResponseDTO]] = None + __properties: ClassVar[List[str]] = ["categories"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDataCategoriesResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in categories (list) + _items = [] + if self.categories: + for _item_categories in self.categories: + if _item_categories: + _items.append(_item_categories.to_dict()) + _dict['categories'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDataCategoriesResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "categories": [ServicingDataCategoryResponseDTO.from_dict(_item) for _item in obj["categories"]] if obj.get("categories") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_category_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_category_response_dto.py new file mode 100644 index 0000000000..da72a8b96f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_category_response_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDataCategoryResponseDTO(BaseModel): + """ + The data category's UUID and display name. + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The display name of the data category.") + id: Optional[StrictStr] = Field(default=None, description="The UUID of the data category.") + __properties: ClassVar[List[str]] = ["name", "id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDataCategoryResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDataCategoryResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "id": obj.get("id") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_security_profile_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_security_profile_dto.py new file mode 100644 index 0000000000..08374e6284 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_data_security_profile_dto.py @@ -0,0 +1,134 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_inherited_access_config_dto import ServicingInheritedAccessConfigDTO +from visier_platform_sdk.models.servicing_inherited_reference_member_filter_config_dto import ServicingInheritedReferenceMemberFilterConfigDTO +from visier_platform_sdk.models.servicing_member_filter_config_dto import ServicingMemberFilterConfigDTO +from visier_platform_sdk.models.servicing_property_set_config_dto import ServicingPropertySetConfigDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDataSecurityProfileDTO(BaseModel): + """ + ServicingDataSecurityProfileDTO + """ # noqa: E501 + analytic_object_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analytic object assigned data security in this permission.", alias="analyticObjectId") + property_set_config: Optional[ServicingPropertySetConfigDTO] = Field(default=None, description="A list of objects representing the data access for an analytic object’s properties.", alias="propertySetConfig") + all_data_point_access: Optional[StrictBool] = Field(default=None, description="If `true`, the permission grants access to the entire population. If `false`, define `memberFilterConfigs` to set custom population access.", alias="allDataPointAccess") + member_filter_configs: Optional[List[ServicingMemberFilterConfigDTO]] = Field(default=None, description="Custom filters that define population access for an item in the permission.", alias="memberFilterConfigs") + inherited_access_configs: Optional[List[ServicingInheritedAccessConfigDTO]] = Field(default=None, description="The events and related objects inherited from the analytic object. By default, all events and related objects associated with the analytic object will be inherited from the analytic object in a permission. For example, if you assign access to Employee, then access to the Employee Exit event is inherited in the permission. To remove access to an event or related object, add the object to `inheritedAccessConfigs` with `removeAccess`: true. To add custom filters to an event or related object, add the object to `inheritedAccessConfigs` and define `memberFilterConfigs`.", alias="inheritedAccessConfigs") + inherited_reference_member_filter_config: Optional[ServicingInheritedReferenceMemberFilterConfigDTO] = Field(default=None, description="Configures the analytic object to inherit population access filters from. The target analytic object must be assigned population access in the permission and have a binding (strong) reference from the source analytic object. * For example, assume `Applicant` -> `Requisition` is configured to be a binding (strong) reference. For `Applicant` (source analytic object) to inherit population access filters from `Requisition` (target analytic object), in the Applicant `dataSecurityProfile`, set `inheritedReferenceMemberFilterConfig` to `Requisition`. In this example, Applicant will inherit filters from Requisition because Requsition is assigned data security in this permission and there is a binding (strong) reference from Applicant to Requisition.", alias="inheritedReferenceMemberFilterConfig") + analytic_object_status: Optional[StrictStr] = Field(default=None, description="The analytic object's validity status. Valid values: Valid, NoData, NotFound. * **Valid**: The object exists and has loaded data. * **NoData**: The object exists but doesn't have loaded data. * **NotFound**: The object doesn't exist.", alias="analyticObjectStatus") + __properties: ClassVar[List[str]] = ["analyticObjectId", "propertySetConfig", "allDataPointAccess", "memberFilterConfigs", "inheritedAccessConfigs", "inheritedReferenceMemberFilterConfig", "analyticObjectStatus"] + + @field_validator('analytic_object_status') + def analytic_object_status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unset', 'Valid', 'NoData', 'NotFound']): + raise ValueError("must be one of enum values ('Unset', 'Valid', 'NoData', 'NotFound')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDataSecurityProfileDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of property_set_config + if self.property_set_config: + _dict['propertySetConfig'] = self.property_set_config.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in member_filter_configs (list) + _items = [] + if self.member_filter_configs: + for _item_member_filter_configs in self.member_filter_configs: + if _item_member_filter_configs: + _items.append(_item_member_filter_configs.to_dict()) + _dict['memberFilterConfigs'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in inherited_access_configs (list) + _items = [] + if self.inherited_access_configs: + for _item_inherited_access_configs in self.inherited_access_configs: + if _item_inherited_access_configs: + _items.append(_item_inherited_access_configs.to_dict()) + _dict['inheritedAccessConfigs'] = _items + # override the default output from pydantic by calling `to_dict()` of inherited_reference_member_filter_config + if self.inherited_reference_member_filter_config: + _dict['inheritedReferenceMemberFilterConfig'] = self.inherited_reference_member_filter_config.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDataSecurityProfileDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjectId": obj.get("analyticObjectId"), + "propertySetConfig": ServicingPropertySetConfigDTO.from_dict(obj["propertySetConfig"]) if obj.get("propertySetConfig") is not None else None, + "allDataPointAccess": obj.get("allDataPointAccess"), + "memberFilterConfigs": [ServicingMemberFilterConfigDTO.from_dict(_item) for _item in obj["memberFilterConfigs"]] if obj.get("memberFilterConfigs") is not None else None, + "inheritedAccessConfigs": [ServicingInheritedAccessConfigDTO.from_dict(_item) for _item in obj["inheritedAccessConfigs"]] if obj.get("inheritedAccessConfigs") is not None else None, + "inheritedReferenceMemberFilterConfig": ServicingInheritedReferenceMemberFilterConfigDTO.from_dict(obj["inheritedReferenceMemberFilterConfig"]) if obj.get("inheritedReferenceMemberFilterConfig") is not None else None, + "analyticObjectStatus": obj.get("analyticObjectStatus") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_delete_permissions_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_delete_permissions_request_dto.py new file mode 100644 index 0000000000..471a0502f6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_delete_permissions_request_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDeletePermissionsRequestDTO(BaseModel): + """ + ServicingDeletePermissionsRequestDTO + """ # noqa: E501 + permission_ids: Optional[List[StrictStr]] = Field(default=None, description="The identifiers of the permissions to delete.", alias="permissionIds") + __properties: ClassVar[List[str]] = ["permissionIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDeletePermissionsRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDeletePermissionsRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissionIds": obj.get("permissionIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_dimension_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_dimension_filter_dto.py new file mode 100644 index 0000000000..51bed2987e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_dimension_filter_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_dynamic_dimension_filter_dto import ServicingDynamicDimensionFilterDTO +from visier_platform_sdk.models.servicing_static_dimension_filter_dto import ServicingStaticDimensionFilterDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDimensionFilterDTO(BaseModel): + """ + ServicingDimensionFilterDTO + """ # noqa: E501 + static_dimension_filter: Optional[ServicingStaticDimensionFilterDTO] = Field(default=None, alias="staticDimensionFilter") + dynamic_dimension_filter: Optional[ServicingDynamicDimensionFilterDTO] = Field(default=None, alias="dynamicDimensionFilter") + __properties: ClassVar[List[str]] = ["staticDimensionFilter", "dynamicDimensionFilter"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDimensionFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of static_dimension_filter + if self.static_dimension_filter: + _dict['staticDimensionFilter'] = self.static_dimension_filter.to_dict() + # override the default output from pydantic by calling `to_dict()` of dynamic_dimension_filter + if self.dynamic_dimension_filter: + _dict['dynamicDimensionFilter'] = self.dynamic_dimension_filter.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDimensionFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "staticDimensionFilter": ServicingStaticDimensionFilterDTO.from_dict(obj["staticDimensionFilter"]) if obj.get("staticDimensionFilter") is not None else None, + "dynamicDimensionFilter": ServicingDynamicDimensionFilterDTO.from_dict(obj["dynamicDimensionFilter"]) if obj.get("dynamicDimensionFilter") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_job_config_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_job_config_dto.py new file mode 100644 index 0000000000..53f694461e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_job_config_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDirectDataJobConfigDTO(BaseModel): + """ + Whether the direct data intake job is a primary job or a supplemental job. + """ # noqa: E501 + supplemental_mode: Optional[StrictStr] = Field(default=None, description="The configuration for the processing job as a primary job (default) or a supplemental job. If a primary job is already defined, the direct data intake job must be supplemental. The valid values are `IS_PRIMARY`, `IS_SUPPLEMENTAL`, and `UNCHANGED`.", alias="supplementalMode") + extend_objects: Optional[List[StrictStr]] = Field(default=None, description="The target analytic objects to load using extension tables. You can extend objects if the job type is supplemental and the target objects already contain data from a previous data version. This allows you to load data for objects that already contain data in Visier.", alias="extendObjects") + __properties: ClassVar[List[str]] = ["supplementalMode", "extendObjects"] + + @field_validator('supplemental_mode') + def supplemental_mode_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['UNCHANGED', 'IS_PRIMARY', 'IS_SUPPLEMENTAL']): + raise ValueError("must be one of enum values ('UNCHANGED', 'IS_PRIMARY', 'IS_SUPPLEMENTAL')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDirectDataJobConfigDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDirectDataJobConfigDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "supplementalMode": obj.get("supplementalMode"), + "extendObjects": obj.get("extendObjects") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_job_status_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_job_status_response_dto.py new file mode 100644 index 0000000000..f8a9e56fe9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_job_status_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDirectDataJobStatusResponseDTO(BaseModel): + """ + The job status information for a committed transaction. + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant for the data load.", alias="tenantCode") + transaction_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the committed transaction.", alias="transactionId") + job_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the processing job.", alias="jobId") + status: Optional[StrictStr] = Field(default=None, description="The status of the processing job.") + message: Optional[StrictStr] = Field(default=None, description="If the processing job fails, this field contains details specific to the failure.") + __properties: ClassVar[List[str]] = ["tenantCode", "transactionId", "jobId", "status", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDirectDataJobStatusResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDirectDataJobStatusResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "transactionId": obj.get("transactionId"), + "jobId": obj.get("jobId"), + "status": obj.get("status"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_list_transactions_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_list_transactions_response_dto.py new file mode 100644 index 0000000000..576b7f07e8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_list_transactions_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_direct_data_transaction_dto import ServicingDirectDataTransactionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDirectDataListTransactionsResponseDTO(BaseModel): + """ + A list of all currently open transactions. + """ # noqa: E501 + transactions: Optional[List[ServicingDirectDataTransactionDTO]] = Field(default=None, description="The list of open transactions.") + __properties: ClassVar[List[str]] = ["transactions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDirectDataListTransactionsResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in transactions (list) + _items = [] + if self.transactions: + for _item_transactions in self.transactions: + if _item_transactions: + _items.append(_item_transactions.to_dict()) + _dict['transactions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDirectDataListTransactionsResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "transactions": [ServicingDirectDataTransactionDTO.from_dict(_item) for _item in obj["transactions"]] if obj.get("transactions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_load_config_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_load_config_dto.py new file mode 100644 index 0000000000..568003a89b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_load_config_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_direct_data_job_config_dto import ServicingDirectDataJobConfigDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDirectDataLoadConfigDTO(BaseModel): + """ + The configuration for the direct data intake, such as the direct data intake job type. + """ # noqa: E501 + job: Optional[ServicingDirectDataJobConfigDTO] = Field(default=None, description="The direct data intake job configuration.") + __properties: ClassVar[List[str]] = ["job"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDirectDataLoadConfigDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of job + if self.job: + _dict['job'] = self.job.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDirectDataLoadConfigDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "job": ServicingDirectDataJobConfigDTO.from_dict(obj["job"]) if obj.get("job") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_schema_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_schema_dto.py new file mode 100644 index 0000000000..14d5bd0996 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_schema_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_direct_data_schema_field_dto import ServicingDirectDataSchemaFieldDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDirectDataSchemaDTO(BaseModel): + """ + Public API Direct Intake schema response object + """ # noqa: E501 + var_schema: Optional[List[ServicingDirectDataSchemaFieldDTO]] = Field(default=None, description="The schema definition for loading a specific object", alias="schema") + __properties: ClassVar[List[str]] = ["schema"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDirectDataSchemaDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in var_schema (list) + _items = [] + if self.var_schema: + for _item_var_schema in self.var_schema: + if _item_var_schema: + _items.append(_item_var_schema.to_dict()) + _dict['schema'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDirectDataSchemaDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "schema": [ServicingDirectDataSchemaFieldDTO.from_dict(_item) for _item in obj["schema"]] if obj.get("schema") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_schema_field_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_schema_field_dto.py new file mode 100644 index 0000000000..85785c3f3d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_schema_field_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDirectDataSchemaFieldDTO(BaseModel): + """ + The definition of each field in an object's schema. + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The field's column name. Column names are case sensitive.") + data_type: Optional[StrictStr] = Field(default=None, description="The column's data type.", alias="dataType") + formats: Optional[List[StrictStr]] = Field(default=None, description="The column's accepted formats, such as date formats like \"yyyy-MM-dd\".") + is_mandatory: Optional[StrictBool] = Field(default=None, description="If true, the field must contain a value to successfully load data into the object.", alias="isMandatory") + empty_values_allowed: Optional[StrictBool] = Field(default=None, description="If true, the value may be empty.", alias="emptyValuesAllowed") + __properties: ClassVar[List[str]] = ["name", "dataType", "formats", "isMandatory", "emptyValuesAllowed"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDirectDataSchemaFieldDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDirectDataSchemaFieldDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "dataType": obj.get("dataType"), + "formats": obj.get("formats"), + "isMandatory": obj.get("isMandatory"), + "emptyValuesAllowed": obj.get("emptyValuesAllowed") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_transaction_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_transaction_dto.py new file mode 100644 index 0000000000..a391880700 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_transaction_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDirectDataTransactionDTO(BaseModel): + """ + An open transaction. + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant for the data load.", alias="tenantCode") + transaction_id: Optional[StrictStr] = Field(default=None, description="The transaction's unique identifier.", alias="transactionId") + created: Optional[StrictStr] = Field(default=None, description="The transaction's creation date and time. The format is YYYY-MM-DDTHH:mm:ss.SSSZ (ISO 8601).") + updated: Optional[StrictStr] = Field(default=None, description="The transaction's last update date and time. The format is YYYY-MM-DDTHH:mm:ss.SSSZ (ISO 8601).") + status: Optional[StrictStr] = Field(default=None, description="The status of the transaction, such as open, progressing, or committed.") + __properties: ClassVar[List[str]] = ["tenantCode", "transactionId", "created", "updated", "status"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDirectDataTransactionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDirectDataTransactionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "transactionId": obj.get("transactionId"), + "created": obj.get("created"), + "updated": obj.get("updated"), + "status": obj.get("status") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_transaction_start_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_transaction_start_response_dto.py new file mode 100644 index 0000000000..31c8f0ff9d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_transaction_start_response_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDirectDataTransactionStartResponseDTO(BaseModel): + """ + The response after successfully creating a transaction. + """ # noqa: E501 + transaction_id: Optional[StrictStr] = Field(default=None, description="The transaction's unique identifier.", alias="transactionId") + __properties: ClassVar[List[str]] = ["transactionId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDirectDataTransactionStartResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDirectDataTransactionStartResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "transactionId": obj.get("transactionId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_upload_file_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_upload_file_response_dto.py new file mode 100644 index 0000000000..c17672eba7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_direct_data_upload_file_response_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDirectDataUploadFileResponseDTO(BaseModel): + """ + The transaction results. If uploading a file, a success response means the upload was successful and doesn't always mean the file was successfully loaded into its target object. + """ # noqa: E501 + transaction_id: Optional[StrictStr] = Field(default=None, description="The unique transaction identifier.", alias="transactionId") + status: Optional[StrictStr] = Field(default=None, description="The status of the request.") + message: Optional[StrictStr] = Field(default=None, description="Upload response message from the provisioning service") + __properties: ClassVar[List[str]] = ["transactionId", "status", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDirectDataUploadFileResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDirectDataUploadFileResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "transactionId": obj.get("transactionId"), + "status": obj.get("status"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_document_search_link_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_document_search_link_dto.py new file mode 100644 index 0000000000..ed39a4fbca --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_document_search_link_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDocumentSearchLinkDTO(BaseModel): + """ + Defines the attributes of a web request to reference documents in the search results. + """ # noqa: E501 + href: Optional[StrictStr] = Field(default=None, description="The URL pointing to the specific document.") + verb: Optional[StrictStr] = Field(default=None, description="The verb to use when formulating the web request. This is commonly `GET`.") + __properties: ClassVar[List[str]] = ["href", "verb"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDocumentSearchLinkDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDocumentSearchLinkDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "href": obj.get("href"), + "verb": obj.get("verb") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_dynamic_dimension_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_dynamic_dimension_filter_dto.py new file mode 100644 index 0000000000..5232b0607e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_dynamic_dimension_filter_dto.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_dynamic_property_mapping_dto import ServicingDynamicPropertyMappingDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDynamicDimensionFilterDTO(BaseModel): + """ + ServicingDynamicDimensionFilterDTO + """ # noqa: E501 + dimension_id: Optional[StrictStr] = Field(default=None, description="The dimension ID associated with the filter.", alias="dimensionId") + subject_reference_path: Optional[List[StrictStr]] = Field(default=None, description="The subject reference path.", alias="subjectReferencePath") + dynamic_property_mappings: Optional[List[ServicingDynamicPropertyMappingDTO]] = Field(default=None, description="The properties assigned population access in the dynamic filter.", alias="dynamicPropertyMappings") + dimension_status: Optional[StrictStr] = Field(default=None, description="The dimension's validity status. Valid values: Valid, NoData, NotFound. * **Valid**: The object exists and has loaded data. * **NoData**: The object exists but doesn't have loaded data. * **NotFound**: The object doesn't exist.", alias="dimensionStatus") + __properties: ClassVar[List[str]] = ["dimensionId", "subjectReferencePath", "dynamicPropertyMappings", "dimensionStatus"] + + @field_validator('dimension_status') + def dimension_status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unset', 'Valid', 'NoData', 'NotFound']): + raise ValueError("must be one of enum values ('Unset', 'Valid', 'NoData', 'NotFound')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDynamicDimensionFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dynamic_property_mappings (list) + _items = [] + if self.dynamic_property_mappings: + for _item_dynamic_property_mappings in self.dynamic_property_mappings: + if _item_dynamic_property_mappings: + _items.append(_item_dynamic_property_mappings.to_dict()) + _dict['dynamicPropertyMappings'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDynamicDimensionFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionId": obj.get("dimensionId"), + "subjectReferencePath": obj.get("subjectReferencePath"), + "dynamicPropertyMappings": [ServicingDynamicPropertyMappingDTO.from_dict(_item) for _item in obj["dynamicPropertyMappings"]] if obj.get("dynamicPropertyMappings") is not None else None, + "dimensionStatus": obj.get("dimensionStatus") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_dynamic_property_mapping_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_dynamic_property_mapping_dto.py new file mode 100644 index 0000000000..d74f216d74 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_dynamic_property_mapping_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_user_property_dto import ServicingUserPropertyDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingDynamicPropertyMappingDTO(BaseModel): + """ + ServicingDynamicPropertyMappingDTO + """ # noqa: E501 + hierarchy_property_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the property.", alias="hierarchyPropertyId") + user_property: Optional[ServicingUserPropertyDTO] = Field(default=None, description="The user property that you want to link the name property or organization head to.", alias="userProperty") + hierarchy_property_status: Optional[StrictStr] = Field(default=None, description="The property's validity status. Valid values: `Valid`, `NotFound`. * **Valid**: The object exists and has loaded data. * **NotFound**: The object doesn't exist.", alias="hierarchyPropertyStatus") + __properties: ClassVar[List[str]] = ["hierarchyPropertyId", "userProperty", "hierarchyPropertyStatus"] + + @field_validator('hierarchy_property_status') + def hierarchy_property_status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unset', 'Valid', 'NoData', 'NotFound']): + raise ValueError("must be one of enum values ('Unset', 'Valid', 'NoData', 'NotFound')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingDynamicPropertyMappingDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user_property + if self.user_property: + _dict['userProperty'] = self.user_property.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingDynamicPropertyMappingDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hierarchyPropertyId": obj.get("hierarchyPropertyId"), + "userProperty": ServicingUserPropertyDTO.from_dict(obj["userProperty"]) if obj.get("userProperty") is not None else None, + "hierarchyPropertyStatus": obj.get("hierarchyPropertyStatus") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_error_dto.py new file mode 100644 index 0000000000..52509e2731 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_error_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingErrorDTO(BaseModel): + """ + ServicingErrorDTO + """ # noqa: E501 + root_cause_id: Optional[StrictStr] = Field(default=None, description="The root cause identifier that allows Visier to determine the source of the problem.", alias="rootCauseId") + error_code: Optional[StrictStr] = Field(default=None, description="A brief identifier of the type of error.", alias="errorCode") + error_message: Optional[StrictStr] = Field(default=None, description="A description of the error that occurred.", alias="errorMessage") + __properties: ClassVar[List[str]] = ["rootCauseId", "errorCode", "errorMessage"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "rootCauseId": obj.get("rootCauseId"), + "errorCode": obj.get("errorCode"), + "errorMessage": obj.get("errorMessage") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_export_production_versions_api_operation_parameters_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_export_production_versions_api_operation_parameters_dto.py new file mode 100644 index 0000000000..f47724d402 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_export_production_versions_api_operation_parameters_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingExportProductionVersionsAPIOperationParametersDTO(BaseModel): + """ + ServicingExportProductionVersionsAPIOperationParametersDTO + """ # noqa: E501 + start_version: Optional[StrictStr] = Field(default=None, description="The unique identifier of the version to start exporting versions from. The range is inclusive.", alias="startVersion") + end_version: Optional[StrictStr] = Field(default=None, description="The unique identifier of the version to stop exporting versions at. The range is inclusive.", alias="endVersion") + excluded_versions: Optional[List[StrictStr]] = Field(default=None, description="A list of versions between `startVersion` and `endVersion` to exclude.", alias="excludedVersions") + __properties: ClassVar[List[str]] = ["startVersion", "endVersion", "excludedVersions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingExportProductionVersionsAPIOperationParametersDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingExportProductionVersionsAPIOperationParametersDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "startVersion": obj.get("startVersion"), + "endVersion": obj.get("endVersion"), + "excludedVersions": obj.get("excludedVersions") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_failed_accessible_tenant_profile_assignment_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_failed_accessible_tenant_profile_assignment_dto.py new file mode 100644 index 0000000000..24aade7732 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_failed_accessible_tenant_profile_assignment_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_error_dto import ServicingErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingFailedAccessibleTenantProfileAssignmentDTO(BaseModel): + """ + ServicingFailedAccessibleTenantProfileAssignmentDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The impacted user ID.", alias="userId") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code.", alias="tenantCode") + for_all_children: Optional[StrictBool] = Field(default=None, description="If true, the target assignment is for all analytic tenants.", alias="forAllChildren") + error: Optional[ServicingErrorDTO] = Field(default=None, description="The details about the error.") + __properties: ClassVar[List[str]] = ["userId", "tenantCode", "forAllChildren", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingFailedAccessibleTenantProfileAssignmentDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of error + if self.error: + _dict['error'] = self.error.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingFailedAccessibleTenantProfileAssignmentDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "tenantCode": obj.get("tenantCode"), + "forAllChildren": obj.get("forAllChildren"), + "error": ServicingErrorDTO.from_dict(obj["error"]) if obj.get("error") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_failed_local_tenant_profile_assignment_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_failed_local_tenant_profile_assignment_dto.py new file mode 100644 index 0000000000..f4bb6f727f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_failed_local_tenant_profile_assignment_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_error_dto import ServicingErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingFailedLocalTenantProfileAssignmentDTO(BaseModel): + """ + ServicingFailedLocalTenantProfileAssignmentDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The impacted user ID.", alias="userId") + error: Optional[ServicingErrorDTO] = Field(default=None, description="The details about the error.") + __properties: ClassVar[List[str]] = ["userId", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingFailedLocalTenantProfileAssignmentDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of error + if self.error: + _dict['error'] = self.error.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingFailedLocalTenantProfileAssignmentDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "error": ServicingErrorDTO.from_dict(obj["error"]) if obj.get("error") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_failed_local_tenant_profile_revoke_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_failed_local_tenant_profile_revoke_dto.py new file mode 100644 index 0000000000..ddf62a2d20 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_failed_local_tenant_profile_revoke_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingFailedLocalTenantProfileRevokeDTO(BaseModel): + """ + ServicingFailedLocalTenantProfileRevokeDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The impacted user ID.", alias="userId") + message: Optional[StrictStr] = Field(default=None, description="The details about the error.") + __properties: ClassVar[List[str]] = ["userId", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingFailedLocalTenantProfileRevokeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingFailedLocalTenantProfileRevokeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_capabilities_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_capabilities_api_response_dto.py new file mode 100644 index 0000000000..debbcf0420 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_capabilities_api_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_capability_dto import ServicingCapabilityDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingGetCapabilitiesAPIResponseDTO(BaseModel): + """ + ServicingGetCapabilitiesAPIResponseDTO + """ # noqa: E501 + capabilities: Optional[List[ServicingCapabilityDTO]] = Field(default=None, description="A list of objects representing the available capabilities.") + __properties: ClassVar[List[str]] = ["capabilities"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingGetCapabilitiesAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in capabilities (list) + _items = [] + if self.capabilities: + for _item_capabilities in self.capabilities: + if _item_capabilities: + _items.append(_item_capabilities.to_dict()) + _dict['capabilities'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingGetCapabilitiesAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "capabilities": [ServicingCapabilityDTO.from_dict(_item) for _item in obj["capabilities"]] if obj.get("capabilities") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_content_packages_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_content_packages_api_response_dto.py new file mode 100644 index 0000000000..f26048e8f6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_content_packages_api_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_content_package_dto import ServicingContentPackageDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingGetContentPackagesAPIResponseDTO(BaseModel): + """ + ServicingGetContentPackagesAPIResponseDTO + """ # noqa: E501 + content_packages: Optional[List[ServicingContentPackageDTO]] = Field(default=None, description="A list of objects representing the available content packages.", alias="contentPackages") + __properties: ClassVar[List[str]] = ["contentPackages"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingGetContentPackagesAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in content_packages (list) + _items = [] + if self.content_packages: + for _item_content_packages in self.content_packages: + if _item_content_packages: + _items.append(_item_content_packages.to_dict()) + _dict['contentPackages'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingGetContentPackagesAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "contentPackages": [ServicingContentPackageDTO.from_dict(_item) for _item in obj["contentPackages"]] if obj.get("contentPackages") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_data_access_sets_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_data_access_sets_api_response_dto.py new file mode 100644 index 0000000000..0e9a974397 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_data_access_sets_api_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_data_access_set_dto import ServicingDataAccessSetDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingGetDataAccessSetsAPIResponseDTO(BaseModel): + """ + ServicingGetDataAccessSetsAPIResponseDTO + """ # noqa: E501 + data_access_sets: Optional[List[ServicingDataAccessSetDTO]] = Field(default=None, description="A list of objects representing the shareable data access sets.", alias="dataAccessSets") + __properties: ClassVar[List[str]] = ["dataAccessSets"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingGetDataAccessSetsAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_access_sets (list) + _items = [] + if self.data_access_sets: + for _item_data_access_sets in self.data_access_sets: + if _item_data_access_sets: + _items.append(_item_data_access_sets.to_dict()) + _dict['dataAccessSets'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingGetDataAccessSetsAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataAccessSets": [ServicingDataAccessSetDTO.from_dict(_item) for _item in obj["dataAccessSets"]] if obj.get("dataAccessSets") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_data_security_objects_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_data_security_objects_api_response_dto.py new file mode 100644 index 0000000000..2e46e4225c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_data_security_objects_api_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_analytic_object_dto import ServicingAnalyticObjectDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingGetDataSecurityObjectsAPIResponseDTO(BaseModel): + """ + ServicingGetDataSecurityObjectsAPIResponseDTO + """ # noqa: E501 + analytic_objects: Optional[List[ServicingAnalyticObjectDTO]] = Field(default=None, description="A list of analytic objects and their related objects that are available to define data access to.", alias="analyticObjects") + __properties: ClassVar[List[str]] = ["analyticObjects"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingGetDataSecurityObjectsAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in analytic_objects (list) + _items = [] + if self.analytic_objects: + for _item_analytic_objects in self.analytic_objects: + if _item_analytic_objects: + _items.append(_item_analytic_objects.to_dict()) + _dict['analyticObjects'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingGetDataSecurityObjectsAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjects": [ServicingAnalyticObjectDTO.from_dict(_item) for _item in obj["analyticObjects"]] if obj.get("analyticObjects") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_permissions_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_permissions_api_response_dto.py new file mode 100644 index 0000000000..93856ff5f3 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_permissions_api_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_permission_dto import ServicingPermissionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingGetPermissionsAPIResponseDTO(BaseModel): + """ + List of available permissions + """ # noqa: E501 + permissions: Optional[List[ServicingPermissionDTO]] = Field(default=None, description="A list of objects representing the available permissions.") + __properties: ClassVar[List[str]] = ["permissions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingGetPermissionsAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in permissions (list) + _items = [] + if self.permissions: + for _item_permissions in self.permissions: + if _item_permissions: + _items.append(_item_permissions.to_dict()) + _dict['permissions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingGetPermissionsAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissions": [ServicingPermissionDTO.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_production_versions_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_production_versions_api_response_dto.py new file mode 100644 index 0000000000..3e97597c0e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_production_versions_api_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_project_dto import ServicingProjectDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingGetProductionVersionsAPIResponseDTO(BaseModel): + """ + ServicingGetProductionVersionsAPIResponseDTO + """ # noqa: E501 + published_versions: Optional[List[ServicingProjectDTO]] = Field(default=None, description="A list of projects that were published to production.", alias="publishedVersions") + __properties: ClassVar[List[str]] = ["publishedVersions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingGetProductionVersionsAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in published_versions (list) + _items = [] + if self.published_versions: + for _item_published_versions in self.published_versions: + if _item_published_versions: + _items.append(_item_published_versions.to_dict()) + _dict['publishedVersions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingGetProductionVersionsAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "publishedVersions": [ServicingProjectDTO.from_dict(_item) for _item in obj["publishedVersions"]] if obj.get("publishedVersions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_projects_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_projects_api_response_dto.py new file mode 100644 index 0000000000..fbbf0b90fa --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_get_projects_api_response_dto.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_project_dto import ServicingProjectDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingGetProjectsAPIResponseDTO(BaseModel): + """ + ServicingGetProjectsAPIResponseDTO + """ # noqa: E501 + open_projects: Optional[List[ServicingProjectDTO]] = Field(default=None, description="A list of objects representing the accessible open projects for the user.", alias="openProjects") + approval_projects: Optional[List[ServicingProjectDTO]] = Field(default=None, description="A list of objects representing the accessible approval projects for the user.", alias="approvalProjects") + rejected_projects: Optional[List[ServicingProjectDTO]] = Field(default=None, description="A list of objects representing the accessible rejected projects for the user.", alias="rejectedProjects") + archived_projects: Optional[List[ServicingProjectDTO]] = Field(default=None, description="A list of objects representing the accessible archived projects for the user.", alias="archivedProjects") + __properties: ClassVar[List[str]] = ["openProjects", "approvalProjects", "rejectedProjects", "archivedProjects"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingGetProjectsAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in open_projects (list) + _items = [] + if self.open_projects: + for _item_open_projects in self.open_projects: + if _item_open_projects: + _items.append(_item_open_projects.to_dict()) + _dict['openProjects'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in approval_projects (list) + _items = [] + if self.approval_projects: + for _item_approval_projects in self.approval_projects: + if _item_approval_projects: + _items.append(_item_approval_projects.to_dict()) + _dict['approvalProjects'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in rejected_projects (list) + _items = [] + if self.rejected_projects: + for _item_rejected_projects in self.rejected_projects: + if _item_rejected_projects: + _items.append(_item_rejected_projects.to_dict()) + _dict['rejectedProjects'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in archived_projects (list) + _items = [] + if self.archived_projects: + for _item_archived_projects in self.archived_projects: + if _item_archived_projects: + _items.append(_item_archived_projects.to_dict()) + _dict['archivedProjects'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingGetProjectsAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "openProjects": [ServicingProjectDTO.from_dict(_item) for _item in obj["openProjects"]] if obj.get("openProjects") is not None else None, + "approvalProjects": [ServicingProjectDTO.from_dict(_item) for _item in obj["approvalProjects"]] if obj.get("approvalProjects") is not None else None, + "rejectedProjects": [ServicingProjectDTO.from_dict(_item) for _item in obj["rejectedProjects"]] if obj.get("rejectedProjects") is not None else None, + "archivedProjects": [ServicingProjectDTO.from_dict(_item) for _item in obj["archivedProjects"]] if obj.get("archivedProjects") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_hierarchy_property_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_hierarchy_property_dto.py new file mode 100644 index 0000000000..0a0b108806 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_hierarchy_property_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingHierarchyPropertyDTO(BaseModel): + """ + ServicingHierarchyPropertyDTO + """ # noqa: E501 + hierarchy_property_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the property.", alias="hierarchyPropertyId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable property name to display in Visier, such as \"Name Property\".", alias="displayName") + __properties: ClassVar[List[str]] = ["hierarchyPropertyId", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingHierarchyPropertyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingHierarchyPropertyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "hierarchyPropertyId": obj.get("hierarchyPropertyId"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_inherited_access_config_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_inherited_access_config_dto.py new file mode 100644 index 0000000000..ca4b11a58e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_inherited_access_config_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_member_filter_config_dto import ServicingMemberFilterConfigDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingInheritedAccessConfigDTO(BaseModel): + """ + ServicingInheritedAccessConfigDTO + """ # noqa: E501 + analytic_object_id: Optional[StrictStr] = Field(default=None, description="The analytic object ID associated with the inherited access configuration.", alias="analyticObjectId") + remove_access: Optional[StrictBool] = Field(default=None, description="The flag for removing access to the inherited analytic object.", alias="removeAccess") + member_filter_configs: Optional[List[ServicingMemberFilterConfigDTO]] = Field(default=None, description="Custom filters that define population access for an inherited analytic object in the permission.", alias="memberFilterConfigs") + __properties: ClassVar[List[str]] = ["analyticObjectId", "removeAccess", "memberFilterConfigs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingInheritedAccessConfigDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in member_filter_configs (list) + _items = [] + if self.member_filter_configs: + for _item_member_filter_configs in self.member_filter_configs: + if _item_member_filter_configs: + _items.append(_item_member_filter_configs.to_dict()) + _dict['memberFilterConfigs'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingInheritedAccessConfigDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjectId": obj.get("analyticObjectId"), + "removeAccess": obj.get("removeAccess"), + "memberFilterConfigs": [ServicingMemberFilterConfigDTO.from_dict(_item) for _item in obj["memberFilterConfigs"]] if obj.get("memberFilterConfigs") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_inherited_reference_member_filter_config_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_inherited_reference_member_filter_config_dto.py new file mode 100644 index 0000000000..0a62ccd891 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_inherited_reference_member_filter_config_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingInheritedReferenceMemberFilterConfigDTO(BaseModel): + """ + ServicingInheritedReferenceMemberFilterConfigDTO + """ # noqa: E501 + target_analytic_object_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analytic object that the source analytic object should inherit filters from. The target analytic object must have a binding (strong) reference from the source analytic object.", alias="targetAnalyticObjectId") + analytic_object_reference: Optional[StrictStr] = Field(default=None, description="The optional object name of a binding (strong) reference to the target analytic object. If not specified, uses the first binding reference from the source to the target analytic object.", alias="analyticObjectReference") + __properties: ClassVar[List[str]] = ["targetAnalyticObjectId", "analyticObjectReference"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingInheritedReferenceMemberFilterConfigDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingInheritedReferenceMemberFilterConfigDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "targetAnalyticObjectId": obj.get("targetAnalyticObjectId"), + "analyticObjectReference": obj.get("analyticObjectReference") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_job_id_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_job_id_response.py new file mode 100644 index 0000000000..6e5b467e72 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_job_id_response.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingJobIdResponse(BaseModel): + """ + The unique identifier of the returned job. + """ # noqa: E501 + job_id: Optional[StrictStr] = Field(default=None, alias="jobId") + __properties: ClassVar[List[str]] = ["jobId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingJobIdResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingJobIdResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "jobId": obj.get("jobId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_last_login_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_last_login_dto.py new file mode 100644 index 0000000000..437bb14c50 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_last_login_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingLastLoginDTO(BaseModel): + """ + ServicingLastLoginDTO + """ # noqa: E501 + timestamp: Optional[StrictStr] = Field(default=None, description="The time that the user last logged into Visier.") + __properties: ClassVar[List[str]] = ["timestamp"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingLastLoginDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingLastLoginDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "timestamp": obj.get("timestamp") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_assignment_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_assignment_request_dto.py new file mode 100644 index 0000000000..ab083eb7bb --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_assignment_request_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingLocalTenantProfileAssignmentRequestDTO(BaseModel): + """ + ServicingLocalTenantProfileAssignmentRequestDTO + """ # noqa: E501 + target_user_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of users to assign this profile.", alias="targetUserIds") + validity_start_time: Optional[StrictStr] = Field(default=None, description="An inclusive date-time when this profile is active.", alias="validityStartTime") + validity_end_time: Optional[StrictStr] = Field(default=None, description="An exclusive date-time when this profile is no longer active.", alias="validityEndTime") + __properties: ClassVar[List[str]] = ["targetUserIds", "validityStartTime", "validityEndTime"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingLocalTenantProfileAssignmentRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingLocalTenantProfileAssignmentRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "targetUserIds": obj.get("targetUserIds"), + "validityStartTime": obj.get("validityStartTime"), + "validityEndTime": obj.get("validityEndTime") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_assignment_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_assignment_response_dto.py new file mode 100644 index 0000000000..1e51d3b66d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_assignment_response_dto.py @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_failed_local_tenant_profile_assignment_dto import ServicingFailedLocalTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_successful_local_tenant_profile_assignment_dto import ServicingSuccessfulLocalTenantProfileAssignmentDTO +from visier_platform_sdk.models.servicing_user_id_error_dto import ServicingUserIdErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingLocalTenantProfileAssignmentResponseDTO(BaseModel): + """ + ServicingLocalTenantProfileAssignmentResponseDTO + """ # noqa: E501 + errors: Optional[StrictBool] = Field(default=None, description="If true, an error was generated by the request.") + bad_user_ids: Optional[List[ServicingUserIdErrorDTO]] = Field(default=None, description="A list of objects representing the user IDs that may not be valid.", alias="badUserIds") + failed_assignments: Optional[List[ServicingFailedLocalTenantProfileAssignmentDTO]] = Field(default=None, description="A list of objects representing any errors that occurred during the assignment operation.", alias="failedAssignments") + successful_assignments: Optional[List[ServicingSuccessfulLocalTenantProfileAssignmentDTO]] = Field(default=None, description="A list of the user IDs that were successfully assigned the profile.", alias="successfulAssignments") + __properties: ClassVar[List[str]] = ["errors", "badUserIds", "failedAssignments", "successfulAssignments"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingLocalTenantProfileAssignmentResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in bad_user_ids (list) + _items = [] + if self.bad_user_ids: + for _item_bad_user_ids in self.bad_user_ids: + if _item_bad_user_ids: + _items.append(_item_bad_user_ids.to_dict()) + _dict['badUserIds'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failed_assignments (list) + _items = [] + if self.failed_assignments: + for _item_failed_assignments in self.failed_assignments: + if _item_failed_assignments: + _items.append(_item_failed_assignments.to_dict()) + _dict['failedAssignments'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in successful_assignments (list) + _items = [] + if self.successful_assignments: + for _item_successful_assignments in self.successful_assignments: + if _item_successful_assignments: + _items.append(_item_successful_assignments.to_dict()) + _dict['successfulAssignments'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingLocalTenantProfileAssignmentResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "errors": obj.get("errors"), + "badUserIds": [ServicingUserIdErrorDTO.from_dict(_item) for _item in obj["badUserIds"]] if obj.get("badUserIds") is not None else None, + "failedAssignments": [ServicingFailedLocalTenantProfileAssignmentDTO.from_dict(_item) for _item in obj["failedAssignments"]] if obj.get("failedAssignments") is not None else None, + "successfulAssignments": [ServicingSuccessfulLocalTenantProfileAssignmentDTO.from_dict(_item) for _item in obj["successfulAssignments"]] if obj.get("successfulAssignments") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_revoke_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_revoke_request_dto.py new file mode 100644 index 0000000000..0124bd6ab3 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_revoke_request_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingLocalTenantProfileRevokeRequestDTO(BaseModel): + """ + ServicingLocalTenantProfileRevokeRequestDTO + """ # noqa: E501 + target_user_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of users to remove this profile from.", alias="targetUserIds") + __properties: ClassVar[List[str]] = ["targetUserIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingLocalTenantProfileRevokeRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingLocalTenantProfileRevokeRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "targetUserIds": obj.get("targetUserIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_revoke_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_revoke_response_dto.py new file mode 100644 index 0000000000..e808210f3f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_local_tenant_profile_revoke_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_failed_local_tenant_profile_revoke_dto import ServicingFailedLocalTenantProfileRevokeDTO +from visier_platform_sdk.models.servicing_successful_local_tenant_profile_assignment_dto import ServicingSuccessfulLocalTenantProfileAssignmentDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingLocalTenantProfileRevokeResponseDTO(BaseModel): + """ + ServicingLocalTenantProfileRevokeResponseDTO + """ # noqa: E501 + failed: Optional[List[ServicingFailedLocalTenantProfileRevokeDTO]] = Field(default=None, description="A list of objects representing any errors that occurred during the assignment operation.") + succeeded: Optional[List[ServicingSuccessfulLocalTenantProfileAssignmentDTO]] = Field(default=None, description="A list of the user IDs that successfully had a profile removed.") + __properties: ClassVar[List[str]] = ["failed", "succeeded"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingLocalTenantProfileRevokeResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in failed (list) + _items = [] + if self.failed: + for _item_failed in self.failed: + if _item_failed: + _items.append(_item_failed.to_dict()) + _dict['failed'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in succeeded (list) + _items = [] + if self.succeeded: + for _item_succeeded in self.succeeded: + if _item_succeeded: + _items.append(_item_succeeded.to_dict()) + _dict['succeeded'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingLocalTenantProfileRevokeResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "failed": [ServicingFailedLocalTenantProfileRevokeDTO.from_dict(_item) for _item in obj["failed"]] if obj.get("failed") is not None else None, + "succeeded": [ServicingSuccessfulLocalTenantProfileAssignmentDTO.from_dict(_item) for _item in obj["succeeded"]] if obj.get("succeeded") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_member_filter_config_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_member_filter_config_dto.py new file mode 100644 index 0000000000..aa64d53791 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_member_filter_config_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_dimension_filter_dto import ServicingDimensionFilterDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingMemberFilterConfigDTO(BaseModel): + """ + ServicingMemberFilterConfigDTO + """ # noqa: E501 + dimension_filters: Optional[List[ServicingDimensionFilterDTO]] = Field(default=None, description="A list of objects representing the custom filters that define population access for the item. A custom filter can be a \"member filter\" (`staticDimensionFilter`) or a \"dynamic filter\" (`dynamicDimensionFilter`).", alias="dimensionFilters") + __properties: ClassVar[List[str]] = ["dimensionFilters"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingMemberFilterConfigDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimension_filters (list) + _items = [] + if self.dimension_filters: + for _item_dimension_filters in self.dimension_filters: + if _item_dimension_filters: + _items.append(_item_dimension_filters.to_dict()) + _dict['dimensionFilters'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingMemberFilterConfigDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionFilters": [ServicingDimensionFilterDTO.from_dict(_item) for _item in obj["dimensionFilters"]] if obj.get("dimensionFilters") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_member_selection_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_member_selection_dto.py new file mode 100644 index 0000000000..75d8d71daa --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_member_selection_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingMemberSelectionDTO(BaseModel): + """ + ServicingMemberSelectionDTO + """ # noqa: E501 + name_path: Optional[List[StrictStr]] = Field(default=None, description="The member name path.", alias="namePath") + excluded: Optional[StrictBool] = Field(default=None, description="If `true`, population access is granted for all members except this member.") + dimension_member_status: Optional[StrictStr] = Field(default=None, description="The dimension member's validity status. Valid values: Valid, NotFound. * **Valid**: The object exists and has loaded data. * **NotFound**: The object doesn't exist.", alias="dimensionMemberStatus") + __properties: ClassVar[List[str]] = ["namePath", "excluded", "dimensionMemberStatus"] + + @field_validator('dimension_member_status') + def dimension_member_status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unset', 'Valid', 'NoData', 'NotFound']): + raise ValueError("must be one of enum values ('Unset', 'Valid', 'NoData', 'NotFound')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingMemberSelectionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingMemberSelectionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "namePath": obj.get("namePath"), + "excluded": obj.get("excluded"), + "dimensionMemberStatus": obj.get("dimensionMemberStatus") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_calculated_property_type_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_calculated_property_type_dto.py new file mode 100644 index 0000000000..9c44909f3c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_calculated_property_type_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationCalculatedPropertyTypeDTO(BaseModel): + """ + ServicingObjectconfigurationCalculatedPropertyTypeDTO + """ # noqa: E501 + data_type: Optional[StrictStr] = Field(default=None, description="The data type of the property, such as Categorical, HourDuration, or Ratio.", alias="dataType") + formula: Optional[StrictStr] = Field(default=None, description="The formula used to calculate the property's value, written in Visier Formula Language.") + __properties: ClassVar[List[str]] = ["dataType", "formula"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationCalculatedPropertyTypeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationCalculatedPropertyTypeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataType": obj.get("dataType"), + "formula": obj.get("formula") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dependent_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dependent_dto.py new file mode 100644 index 0000000000..297aecfb5b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dependent_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationDependentDTO(BaseModel): + """ + Details about a dependent object related to the property to delete. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dependent object.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the dependent object.", alias="displayName") + object_type: Optional[StrictStr] = Field(default=None, description="The type of dependent object, such as a property or parameter.", alias="objectType") + __properties: ClassVar[List[str]] = ["id", "displayName", "objectType"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationDependentDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationDependentDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "objectType": obj.get("objectType") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definition_dto.py new file mode 100644 index 0000000000..0d8caf6cfb --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definition_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationDimensionChangeDefinitionDTO(BaseModel): + """ + ServicingObjectconfigurationDimensionChangeDefinitionDTO + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The symbol name of the dimension; for example, `Career_Level` or `Employee.Vaccination_Status`") + display_name: Optional[StrictStr] = Field(default=None, description="The user-friendly name for the dimension.", alias="displayName") + short_display_name: Optional[StrictStr] = Field(default=None, description="A shortened version of the display name. If the dimension is visible in the solution experience, this name is displayed in visualization titles.", alias="shortDisplayName") + description: Optional[StrictStr] = Field(default=None, description="A short description of the dimension. Descriptions provide in-context help for your users while working in Visier.") + __properties: ClassVar[List[str]] = ["id", "displayName", "shortDisplayName", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationDimensionChangeDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationDimensionChangeDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "shortDisplayName": obj.get("shortDisplayName"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto.py new file mode 100644 index 0000000000..583b8c0a61 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_dimension_change_definition_dto import ServicingObjectconfigurationDimensionChangeDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO(BaseModel): + """ + ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the tenant in which to update dimensions.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="To make changes in a project, specify a project ID.", alias="projectId") + dimensions: Optional[List[ServicingObjectconfigurationDimensionChangeDefinitionDTO]] = Field(default=None, description="The list of dimensions to update.") + __properties: ClassVar[List[str]] = ["tenantCode", "projectId", "dimensions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensions (list) + _items = [] + if self.dimensions: + for _item_dimensions in self.dimensions: + if _item_dimensions: + _items.append(_item_dimensions.to_dict()) + _dict['dimensions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId"), + "dimensions": [ServicingObjectconfigurationDimensionChangeDefinitionDTO.from_dict(_item) for _item in obj["dimensions"]] if obj.get("dimensions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dimensions_change_definitions_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dimensions_change_definitions_dto.py new file mode 100644 index 0000000000..96fe70c156 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_dimensions_change_definitions_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto import ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationDimensionsChangeDefinitionsDTO(BaseModel): + """ + ServicingObjectconfigurationDimensionsChangeDefinitionsDTO + """ # noqa: E501 + dimensions_by_tenant: Optional[List[ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO]] = Field(default=None, description="The dimension updates to make in each tenant.", alias="dimensionsByTenant") + __properties: ClassVar[List[str]] = ["dimensionsByTenant"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationDimensionsChangeDefinitionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in dimensions_by_tenant (list) + _items = [] + if self.dimensions_by_tenant: + for _item_dimensions_by_tenant in self.dimensions_by_tenant: + if _item_dimensions_by_tenant: + _items.append(_item_dimensions_by_tenant.to_dict()) + _dict['dimensionsByTenant'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationDimensionsChangeDefinitionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionsByTenant": [ServicingObjectconfigurationDimensionChangeDefinitionsByTenantDTO.from_dict(_item) for _item in obj["dimensionsByTenant"]] if obj.get("dimensionsByTenant") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_object_change_failure_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_object_change_failure_dto.py new file mode 100644 index 0000000000..f78c1ab00b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_object_change_failure_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationObjectChangeFailureDTO(BaseModel): + """ + ServicingObjectconfigurationObjectChangeFailureDTO + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The symbol name of the object that was not successfully changed.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the object.", alias="displayName") + message: Optional[StrictStr] = Field(default=None, description="An error message describing the cause of the failure.") + rci: Optional[StrictStr] = Field(default=None, description="The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant that the object was not successfully changed in.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project that the object was not successfully changed in.", alias="projectId") + __properties: ClassVar[List[str]] = ["id", "displayName", "message", "rci", "tenantCode", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationObjectChangeFailureDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationObjectChangeFailureDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "message": obj.get("message"), + "rci": obj.get("rci"), + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_object_change_success_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_object_change_success_dto.py new file mode 100644 index 0000000000..8d83bab627 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_object_change_success_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationObjectChangeSuccessDTO(BaseModel): + """ + ServicingObjectconfigurationObjectChangeSuccessDTO + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The symbol name of the object that was successfully changed.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the object.", alias="displayName") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant that the object was changed in.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project that the object was changed in.", alias="projectId") + __properties: ClassVar[List[str]] = ["id", "displayName", "tenantCode", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationObjectChangeSuccessDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationObjectChangeSuccessDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_objects_bulk_change_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_objects_bulk_change_response_dto.py new file mode 100644 index 0000000000..4c97dc0b29 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_objects_bulk_change_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_object_change_failure_dto import ServicingObjectconfigurationObjectChangeFailureDTO +from visier_platform_sdk.models.servicing_objectconfiguration_object_change_success_dto import ServicingObjectconfigurationObjectChangeSuccessDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationObjectsBulkChangeResponseDTO(BaseModel): + """ + ServicingObjectconfigurationObjectsBulkChangeResponseDTO + """ # noqa: E501 + successes: Optional[List[ServicingObjectconfigurationObjectChangeSuccessDTO]] = Field(default=None, description="The objects that were successfully changed.") + failures: Optional[List[ServicingObjectconfigurationObjectChangeFailureDTO]] = Field(default=None, description="The objects that were not successfully changed.") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationObjectsBulkChangeResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationObjectsBulkChangeResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [ServicingObjectconfigurationObjectChangeSuccessDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [ServicingObjectconfigurationObjectChangeFailureDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_properties_change_definitions_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_properties_change_definitions_dto.py new file mode 100644 index 0000000000..3f68cabb18 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_properties_change_definitions_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_property_change_definitions_by_tenant_dto import ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationPropertiesChangeDefinitionsDTO(BaseModel): + """ + ServicingObjectconfigurationPropertiesChangeDefinitionsDTO + """ # noqa: E501 + properties_by_tenant: Optional[List[ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO]] = Field(default=None, description="The property updates to make in each tenant.", alias="propertiesByTenant") + __properties: ClassVar[List[str]] = ["propertiesByTenant"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertiesChangeDefinitionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in properties_by_tenant (list) + _items = [] + if self.properties_by_tenant: + for _item_properties_by_tenant in self.properties_by_tenant: + if _item_properties_by_tenant: + _items.append(_item_properties_by_tenant.to_dict()) + _dict['propertiesByTenant'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertiesChangeDefinitionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "propertiesByTenant": [ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO.from_dict(_item) for _item in obj["propertiesByTenant"]] if obj.get("propertiesByTenant") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_properties_delete_definitions_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_properties_delete_definitions_dto.py new file mode 100644 index 0000000000..e50a0e7eaa --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_properties_delete_definitions_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_definitions_by_tenant_dto import ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO(BaseModel): + """ + Property deletion options. + """ # noqa: E501 + delete_derived_properties: Optional[StrictBool] = Field(default=None, description="If `true`, deletes derived properties along with the properties to delete. Default is `false`.", alias="deleteDerivedProperties") + ignore_property_references: Optional[StrictBool] = Field(default=None, description="If `true`, ignores properties that reference the properties to delete. Default is `false`.", alias="ignorePropertyReferences") + properties_by_tenant: Optional[List[ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO]] = Field(default=None, description="The properties to delete for each tenant.", alias="propertiesByTenant") + __properties: ClassVar[List[str]] = ["deleteDerivedProperties", "ignorePropertyReferences", "propertiesByTenant"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in properties_by_tenant (list) + _items = [] + if self.properties_by_tenant: + for _item_properties_by_tenant in self.properties_by_tenant: + if _item_properties_by_tenant: + _items.append(_item_properties_by_tenant.to_dict()) + _dict['propertiesByTenant'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertiesDeleteDefinitionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "deleteDerivedProperties": obj.get("deleteDerivedProperties"), + "ignorePropertyReferences": obj.get("ignorePropertyReferences"), + "propertiesByTenant": [ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO.from_dict(_item) for _item in obj["propertiesByTenant"]] if obj.get("propertiesByTenant") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_bulk_delete_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_bulk_delete_response_dto.py new file mode 100644 index 0000000000..9ede5de2ee --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_bulk_delete_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_failure_dto import ServicingObjectconfigurationPropertyDeleteFailureDTO +from visier_platform_sdk.models.servicing_objectconfiguration_property_delete_success_dto import ServicingObjectconfigurationPropertyDeleteSuccessDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationPropertyBulkDeleteResponseDTO(BaseModel): + """ + Results of a bulk delete operation. + """ # noqa: E501 + successes: Optional[List[ServicingObjectconfigurationPropertyDeleteSuccessDTO]] = Field(default=None, description="Properties that were successfully deleted.") + failures: Optional[List[ServicingObjectconfigurationPropertyDeleteFailureDTO]] = Field(default=None, description="Properties that were not successfully deleted.") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyBulkDeleteResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyBulkDeleteResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [ServicingObjectconfigurationPropertyDeleteSuccessDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [ServicingObjectconfigurationPropertyDeleteFailureDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_change_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_change_definition_dto.py new file mode 100644 index 0000000000..a6a6eddd01 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_change_definition_dto.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_property_type_dto import ServicingObjectconfigurationPropertyTypeDTO +from visier_platform_sdk.models.servicing_objectconfiguration_tags_dto import ServicingObjectconfigurationTagsDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationPropertyChangeDefinitionDTO(BaseModel): + """ + ServicingObjectconfigurationPropertyChangeDefinitionDTO + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The symbol name of the property; for example, Employee.Birth_Date") + display_name: Optional[StrictStr] = Field(default=None, description="The user-friendly name for the property.", alias="displayName") + short_display_name: Optional[StrictStr] = Field(default=None, description="A shortened version of the display name. If the property is visible in the solution experience, this name is displayed in visualization titles.", alias="shortDisplayName") + description: Optional[StrictStr] = Field(default=None, description="A short description of the property. Descriptions provide in-context help for your users while working in Visier.") + explanation: Optional[StrictStr] = Field(default=None, description="Explanation of the property. This field is used to provide additional information about the property.") + designer_notes: Optional[StrictStr] = Field(default=None, description="Notes for the designer. This field is used to provide additional information about the property.", alias="designerNotes") + type: Optional[ServicingObjectconfigurationPropertyTypeDTO] = Field(default=None, description="The type of the property.") + tags: Optional[ServicingObjectconfigurationTagsDTO] = Field(default=None, description="The tags associated with the property.") + include_with_vee: Optional[StrictBool] = Field(default=None, description="If 'true', the property is included with Vee.", alias="includeWithVee") + __properties: ClassVar[List[str]] = ["id", "displayName", "shortDisplayName", "description", "explanation", "designerNotes", "type", "tags", "includeWithVee"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyChangeDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of type + if self.type: + _dict['type'] = self.type.to_dict() + # override the default output from pydantic by calling `to_dict()` of tags + if self.tags: + _dict['tags'] = self.tags.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyChangeDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "shortDisplayName": obj.get("shortDisplayName"), + "description": obj.get("description"), + "explanation": obj.get("explanation"), + "designerNotes": obj.get("designerNotes"), + "type": ServicingObjectconfigurationPropertyTypeDTO.from_dict(obj["type"]) if obj.get("type") is not None else None, + "tags": ServicingObjectconfigurationTagsDTO.from_dict(obj["tags"]) if obj.get("tags") is not None else None, + "includeWithVee": obj.get("includeWithVee") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_change_definitions_by_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_change_definitions_by_tenant_dto.py new file mode 100644 index 0000000000..27d17a341f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_change_definitions_by_tenant_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_property_change_definition_dto import ServicingObjectconfigurationPropertyChangeDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO(BaseModel): + """ + ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the tenant in which to update properties.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="To make changes in a project, specify a project ID.", alias="projectId") + properties: Optional[List[ServicingObjectconfigurationPropertyChangeDefinitionDTO]] = Field(default=None, description="The list of properties to update.") + __properties: ClassVar[List[str]] = ["tenantCode", "projectId", "properties"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in properties (list) + _items = [] + if self.properties: + for _item_properties in self.properties: + if _item_properties: + _items.append(_item_properties.to_dict()) + _dict['properties'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyChangeDefinitionsByTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId"), + "properties": [ServicingObjectconfigurationPropertyChangeDefinitionDTO.from_dict(_item) for _item in obj["properties"]] if obj.get("properties") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_delete_definitions_by_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_delete_definitions_by_tenant_dto.py new file mode 100644 index 0000000000..4360a2f97d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_delete_definitions_by_tenant_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO(BaseModel): + """ + The properties to delete for a specific tenant. + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant to delete properties from. Default is the current tenant.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project in which to delete properties. If omitted and the ProjectID request header is not defined, the change is published to production immediately.", alias="projectId") + property_ids: Optional[List[StrictStr]] = Field(default=None, description="The IDs of the properties to delete.", alias="propertyIds") + __properties: ClassVar[List[str]] = ["tenantCode", "projectId", "propertyIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyDeleteDefinitionsByTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId"), + "propertyIds": obj.get("propertyIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_delete_failure_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_delete_failure_dto.py new file mode 100644 index 0000000000..95407e48b8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_delete_failure_dto.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_dependent_dto import ServicingObjectconfigurationDependentDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationPropertyDeleteFailureDTO(BaseModel): + """ + Details about a failed property deletion. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the property.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the property.", alias="displayName") + message: Optional[StrictStr] = Field(default=None, description="An error message describing the cause of the failure.") + rci: Optional[StrictStr] = Field(default=None, description="The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant in which the property wasn't deleted.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project in which the property wasn't deleted.", alias="projectId") + derived_dependents_to_delete: Optional[List[ServicingObjectconfigurationDependentDTO]] = Field(default=None, description="The derived dependents that would have been deleted if the deletion was successful.", alias="derivedDependentsToDelete") + reference_dependents_to_ignore: Optional[List[ServicingObjectconfigurationDependentDTO]] = Field(default=None, description="Dependents that reference this property and could be affected.", alias="referenceDependentsToIgnore") + __properties: ClassVar[List[str]] = ["id", "displayName", "message", "rci", "tenantCode", "projectId", "derivedDependentsToDelete", "referenceDependentsToIgnore"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyDeleteFailureDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in derived_dependents_to_delete (list) + _items = [] + if self.derived_dependents_to_delete: + for _item_derived_dependents_to_delete in self.derived_dependents_to_delete: + if _item_derived_dependents_to_delete: + _items.append(_item_derived_dependents_to_delete.to_dict()) + _dict['derivedDependentsToDelete'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in reference_dependents_to_ignore (list) + _items = [] + if self.reference_dependents_to_ignore: + for _item_reference_dependents_to_ignore in self.reference_dependents_to_ignore: + if _item_reference_dependents_to_ignore: + _items.append(_item_reference_dependents_to_ignore.to_dict()) + _dict['referenceDependentsToIgnore'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyDeleteFailureDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "message": obj.get("message"), + "rci": obj.get("rci"), + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId"), + "derivedDependentsToDelete": [ServicingObjectconfigurationDependentDTO.from_dict(_item) for _item in obj["derivedDependentsToDelete"]] if obj.get("derivedDependentsToDelete") is not None else None, + "referenceDependentsToIgnore": [ServicingObjectconfigurationDependentDTO.from_dict(_item) for _item in obj["referenceDependentsToIgnore"]] if obj.get("referenceDependentsToIgnore") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_delete_success_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_delete_success_dto.py new file mode 100644 index 0000000000..39f0dfd985 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_delete_success_dto.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_dependent_dto import ServicingObjectconfigurationDependentDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationPropertyDeleteSuccessDTO(BaseModel): + """ + Details about a successful property deletion. + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the property.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the property.", alias="displayName") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant in which the property was deleted.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project in which the property was deleted.", alias="projectId") + derived_dependents_deleted: Optional[List[ServicingObjectconfigurationDependentDTO]] = Field(default=None, description="The derived dependents that were deleted along with the property.", alias="derivedDependentsDeleted") + reference_dependents_ignored: Optional[List[ServicingObjectconfigurationDependentDTO]] = Field(default=None, description="Dependents that reference the property and were ignored during deletion.", alias="referenceDependentsIgnored") + __properties: ClassVar[List[str]] = ["id", "displayName", "tenantCode", "projectId", "derivedDependentsDeleted", "referenceDependentsIgnored"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyDeleteSuccessDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in derived_dependents_deleted (list) + _items = [] + if self.derived_dependents_deleted: + for _item_derived_dependents_deleted in self.derived_dependents_deleted: + if _item_derived_dependents_deleted: + _items.append(_item_derived_dependents_deleted.to_dict()) + _dict['derivedDependentsDeleted'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in reference_dependents_ignored (list) + _items = [] + if self.reference_dependents_ignored: + for _item_reference_dependents_ignored in self.reference_dependents_ignored: + if _item_reference_dependents_ignored: + _items.append(_item_reference_dependents_ignored.to_dict()) + _dict['referenceDependentsIgnored'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyDeleteSuccessDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "displayName": obj.get("displayName"), + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId"), + "derivedDependentsDeleted": [ServicingObjectconfigurationDependentDTO.from_dict(_item) for _item in obj["derivedDependentsDeleted"]] if obj.get("derivedDependentsDeleted") is not None else None, + "referenceDependentsIgnored": [ServicingObjectconfigurationDependentDTO.from_dict(_item) for _item in obj["referenceDependentsIgnored"]] if obj.get("referenceDependentsIgnored") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_type_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_type_dto.py new file mode 100644 index 0000000000..ca1b385405 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_property_type_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_objectconfiguration_calculated_property_type_dto import ServicingObjectconfigurationCalculatedPropertyTypeDTO +from visier_platform_sdk.models.servicing_objectconfiguration_simple_property_type_dto import ServicingObjectconfigurationSimplePropertyTypeDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationPropertyTypeDTO(BaseModel): + """ + ServicingObjectconfigurationPropertyTypeDTO + """ # noqa: E501 + simple: Optional[ServicingObjectconfigurationSimplePropertyTypeDTO] = Field(default=None, description="The simple property type, which provides a single value directly from the data.") + calculated: Optional[ServicingObjectconfigurationCalculatedPropertyTypeDTO] = Field(default=None, description="The calculated property type, which derives its value using a formula.") + __properties: ClassVar[List[str]] = ["simple", "calculated"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyTypeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of simple + if self.simple: + _dict['simple'] = self.simple.to_dict() + # override the default output from pydantic by calling `to_dict()` of calculated + if self.calculated: + _dict['calculated'] = self.calculated.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationPropertyTypeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "simple": ServicingObjectconfigurationSimplePropertyTypeDTO.from_dict(obj["simple"]) if obj.get("simple") is not None else None, + "calculated": ServicingObjectconfigurationCalculatedPropertyTypeDTO.from_dict(obj["calculated"]) if obj.get("calculated") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_simple_property_type_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_simple_property_type_dto.py new file mode 100644 index 0000000000..7725644f93 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_simple_property_type_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationSimplePropertyTypeDTO(BaseModel): + """ + ServicingObjectconfigurationSimplePropertyTypeDTO + """ # noqa: E501 + data_type: Optional[StrictStr] = Field(default=None, description="The data type of the property, such as Categorical, HourDuration, or Ratio.", alias="dataType") + __properties: ClassVar[List[str]] = ["dataType"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationSimplePropertyTypeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationSimplePropertyTypeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataType": obj.get("dataType") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_tags_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_tags_dto.py new file mode 100644 index 0000000000..d684fb7e41 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_objectconfiguration_tags_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingObjectconfigurationTagsDTO(BaseModel): + """ + Wrapper to distinguish between an empty list and a null/unset list. + """ # noqa: E501 + ids: Optional[List[StrictStr]] = Field(default=None, description="The tag ids.") + __properties: ClassVar[List[str]] = ["ids"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationTagsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingObjectconfigurationTagsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "ids": obj.get("ids") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_by_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_by_tenant_dto.py new file mode 100644 index 0000000000..9cc3b62445 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_by_tenant_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_permission_assigned_user_dto import ServicingPermissionAssignedUserDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPermissionAssignedByTenantDTO(BaseModel): + """ + The users assigned a specific permission, grouped by tenant. + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the tenant.", alias="tenantCode") + users: Optional[List[ServicingPermissionAssignedUserDTO]] = Field(default=None, description="A list of objects representing the users that the permission is assigned to.") + __properties: ClassVar[List[str]] = ["tenantCode", "users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPermissionAssignedByTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPermissionAssignedByTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "users": [ServicingPermissionAssignedUserDTO.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..2d40febe3d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_for_local_tenant_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPermissionAssignedForLocalTenantDTO(BaseModel): + """ + ServicingPermissionAssignedForLocalTenantDTO + """ # noqa: E501 + permission_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the permission.", alias="permissionId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable permission name to display in Visier, such as \"Diversity Access\".", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="A user-defined description of the permission.") + __properties: ClassVar[List[str]] = ["permissionId", "displayName", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPermissionAssignedForLocalTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPermissionAssignedForLocalTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissionId": obj.get("permissionId"), + "displayName": obj.get("displayName"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_user_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_user_dto.py new file mode 100644 index 0000000000..1c2c729713 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_user_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPermissionAssignedUserDTO(BaseModel): + """ + The user and the method through which the user was assigned the permission. + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user.", alias="userId") + username: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@visier.com.") + permission_from: Optional[StrictStr] = Field(default=None, description="The method through which the user was assigned the permission. The permission may be assigned through the following options: - User: The permission was directly assigned to the user. - UserGroup: The permission was assigned because the user belongs to a user group that is assigned the permission. - UserAndUserGroup: The permission was directly assigned to the user and assigned because the user belongs to a user group that is assigned the permission.", alias="permissionFrom") + __properties: ClassVar[List[str]] = ["userId", "username", "permissionFrom"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPermissionAssignedUserDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPermissionAssignedUserDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "username": obj.get("username"), + "permissionFrom": obj.get("permissionFrom") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_users_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_users_dto.py new file mode 100644 index 0000000000..f9d02aab04 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_assigned_users_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_permission_assigned_by_tenant_dto import ServicingPermissionAssignedByTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPermissionAssignedUsersDTO(BaseModel): + """ + Users that are assigned a specific permission. + """ # noqa: E501 + tenants: Optional[List[ServicingPermissionAssignedByTenantDTO]] = Field(default=None, description="A list of objects representing the users that are assigned the specific permission, organized by the tenants the users belong to.") + limit: Optional[StrictInt] = Field(default=None, description="The number of results to return. The maximum number of tenants to retrieve is 100.") + start: Optional[StrictInt] = Field(default=None, description="The index of the tenant to start retrieving results from, also known as offset. The index begins at 0.") + __properties: ClassVar[List[str]] = ["tenants", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPermissionAssignedUsersDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPermissionAssignedUsersDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [ServicingPermissionAssignedByTenantDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_bulk_operation_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_bulk_operation_response_dto.py new file mode 100644 index 0000000000..60776e11b5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_bulk_operation_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_permission_failure_dto import ServicingPermissionFailureDTO +from visier_platform_sdk.models.servicing_permission_success_dto import ServicingPermissionSuccessDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPermissionBulkOperationResponseDTO(BaseModel): + """ + ServicingPermissionBulkOperationResponseDTO + """ # noqa: E501 + successes: Optional[List[ServicingPermissionSuccessDTO]] = Field(default=None, description="The successfully processed permissions.") + failures: Optional[List[ServicingPermissionFailureDTO]] = Field(default=None, description="The permissions that did not process and any relevant error information.") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPermissionBulkOperationResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPermissionBulkOperationResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [ServicingPermissionSuccessDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [ServicingPermissionFailureDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_dto.py new file mode 100644 index 0000000000..f4762ea7a9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_dto.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_admin_capability_config_dto import ServicingAdminCapabilityConfigDTO +from visier_platform_sdk.models.servicing_data_security_profile_dto import ServicingDataSecurityProfileDTO +from visier_platform_sdk.models.servicing_role_modules_config_dto import ServicingRoleModulesConfigDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPermissionDTO(BaseModel): + """ + ServicingPermissionDTO + """ # noqa: E501 + permission_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the permission.", alias="permissionId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable permission name to display in Visier, such as \"Diversity Access\".", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="A user-defined description of the permission.") + data_security_profiles: Optional[List[ServicingDataSecurityProfileDTO]] = Field(default=None, description="A list of objects representing the data security for each item in a permission.", alias="dataSecurityProfiles") + admin_capability_config: Optional[ServicingAdminCapabilityConfigDTO] = Field(default=None, description="The capabilities assigned in the permission.", alias="adminCapabilityConfig") + role_modules_config: Optional[ServicingRoleModulesConfigDTO] = Field(default=None, description="A list of content packages assigned to the permission.", alias="roleModulesConfig") + __properties: ClassVar[List[str]] = ["permissionId", "displayName", "description", "dataSecurityProfiles", "adminCapabilityConfig", "roleModulesConfig"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPermissionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data_security_profiles (list) + _items = [] + if self.data_security_profiles: + for _item_data_security_profiles in self.data_security_profiles: + if _item_data_security_profiles: + _items.append(_item_data_security_profiles.to_dict()) + _dict['dataSecurityProfiles'] = _items + # override the default output from pydantic by calling `to_dict()` of admin_capability_config + if self.admin_capability_config: + _dict['adminCapabilityConfig'] = self.admin_capability_config.to_dict() + # override the default output from pydantic by calling `to_dict()` of role_modules_config + if self.role_modules_config: + _dict['roleModulesConfig'] = self.role_modules_config.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPermissionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissionId": obj.get("permissionId"), + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "dataSecurityProfiles": [ServicingDataSecurityProfileDTO.from_dict(_item) for _item in obj["dataSecurityProfiles"]] if obj.get("dataSecurityProfiles") is not None else None, + "adminCapabilityConfig": ServicingAdminCapabilityConfigDTO.from_dict(obj["adminCapabilityConfig"]) if obj.get("adminCapabilityConfig") is not None else None, + "roleModulesConfig": ServicingRoleModulesConfigDTO.from_dict(obj["roleModulesConfig"]) if obj.get("roleModulesConfig") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_error_dto.py new file mode 100644 index 0000000000..d279baf504 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_error_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPermissionErrorDTO(BaseModel): + """ + ServicingPermissionErrorDTO + """ # noqa: E501 + message: Optional[StrictStr] = Field(default=None, description="Error message") + rci: Optional[StrictStr] = Field(default=None, description="A root cause identifier that allows Visier to determine the source of the problem.") + __properties: ClassVar[List[str]] = ["message", "rci"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPermissionErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPermissionErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "rci": obj.get("rci") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_failure_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_failure_dto.py new file mode 100644 index 0000000000..afe3e218d1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_failure_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_permission_error_dto import ServicingPermissionErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPermissionFailureDTO(BaseModel): + """ + ServicingPermissionFailureDTO + """ # noqa: E501 + permission_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the permission.", alias="permissionId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable permission name to display in Visier, such as \"Diversity Access\".", alias="displayName") + error: Optional[ServicingPermissionErrorDTO] = Field(default=None, description="The error associated with the failure.") + __properties: ClassVar[List[str]] = ["permissionId", "displayName", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPermissionFailureDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of error + if self.error: + _dict['error'] = self.error.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPermissionFailureDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissionId": obj.get("permissionId"), + "displayName": obj.get("displayName"), + "error": ServicingPermissionErrorDTO.from_dict(obj["error"]) if obj.get("error") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_success_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_success_dto.py new file mode 100644 index 0000000000..a12ecfff9d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_permission_success_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPermissionSuccessDTO(BaseModel): + """ + ServicingPermissionSuccessDTO + """ # noqa: E501 + permission_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the permission.", alias="permissionId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable permission name to display in Visier, such as \"Diversity Access\".", alias="displayName") + __properties: ClassVar[List[str]] = ["permissionId", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPermissionSuccessDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPermissionSuccessDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "permissionId": obj.get("permissionId"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_version_api_operation_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_version_api_operation_request_dto.py new file mode 100644 index 0000000000..fcef3ad7e0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_version_api_operation_request_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProductionVersionAPIOperationRequestDTO(BaseModel): + """ + ServicingProductionVersionAPIOperationRequestDTO + """ # noqa: E501 + operation: Optional[StrictStr] = Field(default=None, description="The operation to perform. Valid values: * `rollBackTo`: Create a project that rolls back the production version to the specified version. The project contains uncommitted changes that reverse the published versions after the target production version.") + __properties: ClassVar[List[str]] = ["operation"] + + @field_validator('operation') + def operation_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['unknownProductionVersionAPIOperation', 'rollBackTo']): + raise ValueError("must be one of enum values ('unknownProductionVersionAPIOperation', 'rollBackTo')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProductionVersionAPIOperationRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProductionVersionAPIOperationRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "operation": obj.get("operation") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_version_api_operation_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_version_api_operation_response_dto.py new file mode 100644 index 0000000000..00fa6380d7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_version_api_operation_response_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_project_dto import ServicingProjectDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProductionVersionAPIOperationResponseDTO(BaseModel): + """ + ServicingProductionVersionAPIOperationResponseDTO + """ # noqa: E501 + roll_back_to: Optional[ServicingProjectDTO] = Field(default=None, description="The project created by the `rollBackTo` operation.", alias="rollBackTo") + __properties: ClassVar[List[str]] = ["rollBackTo"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProductionVersionAPIOperationResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of roll_back_to + if self.roll_back_to: + _dict['rollBackTo'] = self.roll_back_to.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProductionVersionAPIOperationResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "rollBackTo": ServicingProjectDTO.from_dict(obj["rollBackTo"]) if obj.get("rollBackTo") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_versions_api_operation_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_versions_api_operation_request_dto.py new file mode 100644 index 0000000000..ee8cfd8a3c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_versions_api_operation_request_dto.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_export_production_versions_api_operation_parameters_dto import ServicingExportProductionVersionsAPIOperationParametersDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProductionVersionsAPIOperationRequestDTO(BaseModel): + """ + ServicingProductionVersionsAPIOperationRequestDTO + """ # noqa: E501 + operation: Optional[StrictStr] = Field(default=None, description="The operation to perform. Valid values: * `export`: Export the project changes of the requested production versions and their related files, such as any Guidebook images. If successful, a ZIP file is returned containing any relevant image files and a JSON file with the production project changes.") + export_parameters: Optional[ServicingExportProductionVersionsAPIOperationParametersDTO] = Field(default=None, description="The parameters for the `export` option, such as the production version to start exporting versions from. Required for `export` operations.", alias="exportParameters") + __properties: ClassVar[List[str]] = ["operation", "exportParameters"] + + @field_validator('operation') + def operation_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['unknownProductionVersionsAPIOperation', 'export']): + raise ValueError("must be one of enum values ('unknownProductionVersionsAPIOperation', 'export')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProductionVersionsAPIOperationRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of export_parameters + if self.export_parameters: + _dict['exportParameters'] = self.export_parameters.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProductionVersionsAPIOperationRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "operation": obj.get("operation"), + "exportParameters": ServicingExportProductionVersionsAPIOperationParametersDTO.from_dict(obj["exportParameters"]) if obj.get("exportParameters") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_versions_api_operation_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_versions_api_operation_response_dto.py new file mode 100644 index 0000000000..de7954448b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_production_versions_api_operation_response_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProductionVersionsAPIOperationResponseDTO(BaseModel): + """ + ServicingProductionVersionsAPIOperationResponseDTO + """ # noqa: E501 + export: Optional[Dict[str, Any]] = Field(default=None, description="The result of the `export` operation.") + __properties: ClassVar[List[str]] = ["export"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProductionVersionsAPIOperationResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProductionVersionsAPIOperationResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "export": obj.get("export") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profile_assigned_for_accessible_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profile_assigned_for_accessible_tenant_dto.py new file mode 100644 index 0000000000..202ea61a5b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profile_assigned_for_accessible_tenant_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProfileAssignedForAccessibleTenantDTO(BaseModel): + """ + ServicingProfileAssignedForAccessibleTenantDTO + """ # noqa: E501 + profile_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the profile.", alias="profileId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable profile name to display in Visier such as \"Partner Service Manager\".", alias="displayName") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant on which this profile is assigned.", alias="tenantCode") + for_all_children: Optional[StrictBool] = Field(default=None, description="If true, the profile is assigned for all the analytic tenants of the administrating tenant.", alias="forAllChildren") + validity_start_time: Optional[StrictStr] = Field(default=None, description="An inclusive date-time when this profile is active. Note: Long.Min_Value means that startTime is undefined.", alias="validityStartTime") + validity_end_time: Optional[StrictStr] = Field(default=None, description="An exclusive date-time when this profile is no longer active. Note: Long.Max_Value means that endTime is undefined and is equivalent to permanent access.", alias="validityEndTime") + __properties: ClassVar[List[str]] = ["profileId", "displayName", "tenantCode", "forAllChildren", "validityStartTime", "validityEndTime"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProfileAssignedForAccessibleTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProfileAssignedForAccessibleTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "profileId": obj.get("profileId"), + "displayName": obj.get("displayName"), + "tenantCode": obj.get("tenantCode"), + "forAllChildren": obj.get("forAllChildren"), + "validityStartTime": obj.get("validityStartTime"), + "validityEndTime": obj.get("validityEndTime") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profile_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profile_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..e3c67f111a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profile_assigned_for_local_tenant_dto.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_additional_capabilities_dto import ServicingAdditionalCapabilitiesDTO +from visier_platform_sdk.models.servicing_capabilities_dto import ServicingCapabilitiesDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProfileAssignedForLocalTenantDTO(BaseModel): + """ + ServicingProfileAssignedForLocalTenantDTO + """ # noqa: E501 + profile_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the profile.", alias="profileId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable profile name to display in Visier, such as \"Partner Service Manager\".", alias="displayName") + validity_start_time: Optional[StrictStr] = Field(default=None, description="An inclusive date-time when this profile is active.", alias="validityStartTime") + validity_end_time: Optional[StrictStr] = Field(default=None, description="An exclusive date-time when this profile is no longer active.", alias="validityEndTime") + capabilities: Optional[List[ServicingCapabilitiesDTO]] = Field(default=None, description="A list of objects representing the access that this profile has for the capabilities of this profile.") + additional_capabilities: Optional[ServicingAdditionalCapabilitiesDTO] = Field(default=None, description="A list of the additional capabilities that are assigned to this profile.", alias="additionalCapabilities") + __properties: ClassVar[List[str]] = ["profileId", "displayName", "validityStartTime", "validityEndTime", "capabilities", "additionalCapabilities"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProfileAssignedForLocalTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in capabilities (list) + _items = [] + if self.capabilities: + for _item_capabilities in self.capabilities: + if _item_capabilities: + _items.append(_item_capabilities.to_dict()) + _dict['capabilities'] = _items + # override the default output from pydantic by calling `to_dict()` of additional_capabilities + if self.additional_capabilities: + _dict['additionalCapabilities'] = self.additional_capabilities.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProfileAssignedForLocalTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "profileId": obj.get("profileId"), + "displayName": obj.get("displayName"), + "validityStartTime": obj.get("validityStartTime"), + "validityEndTime": obj.get("validityEndTime"), + "capabilities": [ServicingCapabilitiesDTO.from_dict(_item) for _item in obj["capabilities"]] if obj.get("capabilities") is not None else None, + "additionalCapabilities": ServicingAdditionalCapabilitiesDTO.from_dict(obj["additionalCapabilities"]) if obj.get("additionalCapabilities") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profile_get_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profile_get_api_response_dto.py new file mode 100644 index 0000000000..e6b30def7a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profile_get_api_response_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_capabilities_dto import ServicingCapabilitiesDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProfileGetAPIResponseDTO(BaseModel): + """ + ServicingProfileGetAPIResponseDTO + """ # noqa: E501 + profile_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the profile.", alias="profileId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable profile name to display in Visier. For example, \"Partner Service Manager\".", alias="displayName") + capabilities: Optional[List[ServicingCapabilitiesDTO]] = Field(default=None, description="A list of objects representing the access that this profile has for the capabilities of this profile.") + additional_capabilities: Optional[List[StrictStr]] = Field(default=None, description="A list of the additional capabilities that are assigned to this profile.", alias="additionalCapabilities") + __properties: ClassVar[List[str]] = ["profileId", "displayName", "capabilities", "additionalCapabilities"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProfileGetAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in capabilities (list) + _items = [] + if self.capabilities: + for _item_capabilities in self.capabilities: + if _item_capabilities: + _items.append(_item_capabilities.to_dict()) + _dict['capabilities'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProfileGetAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "profileId": obj.get("profileId"), + "displayName": obj.get("displayName"), + "capabilities": [ServicingCapabilitiesDTO.from_dict(_item) for _item in obj["capabilities"]] if obj.get("capabilities") is not None else None, + "additionalCapabilities": obj.get("additionalCapabilities") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profiles_get_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profiles_get_api_response_dto.py new file mode 100644 index 0000000000..898c7fe440 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_profiles_get_api_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_profile_get_api_response_dto import ServicingProfileGetAPIResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProfilesGetAPIResponseDTO(BaseModel): + """ + ServicingProfilesGetAPIResponseDTO + """ # noqa: E501 + profiles: Optional[List[ServicingProfileGetAPIResponseDTO]] = Field(default=None, description="A list of objects representing the available profiles.") + __properties: ClassVar[List[str]] = ["profiles"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProfilesGetAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in profiles (list) + _items = [] + if self.profiles: + for _item_profiles in self.profiles: + if _item_profiles: + _items.append(_item_profiles.to_dict()) + _dict['profiles'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProfilesGetAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "profiles": [ServicingProfileGetAPIResponseDTO.from_dict(_item) for _item in obj["profiles"]] if obj.get("profiles") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_commits_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_commits_api_response_dto.py new file mode 100644 index 0000000000..5a504f3c0b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_commits_api_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_commit_dto import ServicingCommitDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProjectCommitsAPIResponseDTO(BaseModel): + """ + ServicingProjectCommitsAPIResponseDTO + """ # noqa: E501 + commits: Optional[List[ServicingCommitDTO]] = Field(default=None, description="A list of committed changes in the project.") + __properties: ClassVar[List[str]] = ["commits"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProjectCommitsAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in commits (list) + _items = [] + if self.commits: + for _item_commits in self.commits: + if _item_commits: + _items.append(_item_commits.to_dict()) + _dict['commits'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProjectCommitsAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "commits": [ServicingCommitDTO.from_dict(_item) for _item in obj["commits"]] if obj.get("commits") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_dto.py new file mode 100644 index 0000000000..3a848dd543 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_dto.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProjectDTO(BaseModel): + """ + ServicingProjectDTO + """ # noqa: E501 + id: Optional[StrictStr] = Field(default=None, description="The unique ID of the project. Omit when creating a new project.") + name: Optional[StrictStr] = Field(default=None, description="An identifiable project name to display in Visier.") + description: Optional[StrictStr] = Field(default=None, description="A description of the project.") + release_version: Optional[StrictStr] = Field(default=None, description="The release version of the project.", alias="releaseVersion") + ticket_number: Optional[StrictStr] = Field(default=None, description="The change management ticket number of the project.", alias="ticketNumber") + version_number: Optional[StrictInt] = Field(default=None, description="The version number of the project.", alias="versionNumber") + capabilities: Optional[List[StrictStr]] = Field(default=None, description="The current user's capabilities for the project. Users with `canWrite`, `canShare`, or `owner` capabilities can add and commit changes to the project. **canRead**: The project has been shared to the user with `View` access. **canWrite**: The project has been shared to the user with `Edit` access. **canShare**: The project has been shared to the user with `Share` access. **owner**: The user is the owner of the project. Omit when creating a new project.") + __properties: ClassVar[List[str]] = ["id", "name", "description", "releaseVersion", "ticketNumber", "versionNumber", "capabilities"] + + @field_validator('capabilities') + def capabilities_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + for i in value: + if i not in set(['canRead', 'canWrite', 'canShare', 'owner']): + raise ValueError("each list item must be one of ('canRead', 'canWrite', 'canShare', 'owner')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProjectDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProjectDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description"), + "releaseVersion": obj.get("releaseVersion"), + "ticketNumber": obj.get("ticketNumber"), + "versionNumber": obj.get("versionNumber"), + "capabilities": obj.get("capabilities") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_operation_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_operation_request_dto.py new file mode 100644 index 0000000000..283022bdd5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_operation_request_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProjectOperationRequestDTO(BaseModel): + """ + ServicingProjectOperationRequestDTO + """ # noqa: E501 + operation: Optional[StrictStr] = Field(default=None, description="The operation to perform on a draft project. Valid values: * `commitAndPublish`: Commits the requesting user's changes and publishes the draft project to production.") + __properties: ClassVar[List[str]] = ["operation"] + + @field_validator('operation') + def operation_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['unknown', 'commitAndPublish']): + raise ValueError("must be one of enum values ('unknown', 'commitAndPublish')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProjectOperationRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProjectOperationRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "operation": obj.get("operation") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_operation_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_operation_response_dto.py new file mode 100644 index 0000000000..4c31d68b62 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_project_operation_response_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_commit_and_publish_operation_response_dto import ServicingCommitAndPublishOperationResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingProjectOperationResponseDTO(BaseModel): + """ + ServicingProjectOperationResponseDTO + """ # noqa: E501 + commit_and_publish: Optional[ServicingCommitAndPublishOperationResponseDTO] = Field(default=None, description="The result of the `commitAndPublish` operation.", alias="commitAndPublish") + __properties: ClassVar[List[str]] = ["commitAndPublish"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingProjectOperationResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of commit_and_publish + if self.commit_and_publish: + _dict['commitAndPublish'] = self.commit_and_publish.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingProjectOperationResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "commitAndPublish": ServicingCommitAndPublishOperationResponseDTO.from_dict(obj["commitAndPublish"]) if obj.get("commitAndPublish") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_property_access_config_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_property_access_config_dto.py new file mode 100644 index 0000000000..b6a5838fd0 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_property_access_config_dto.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPropertyAccessConfigDTO(BaseModel): + """ + ServicingPropertyAccessConfigDTO + """ # noqa: E501 + property_id: Optional[StrictStr] = Field(default=None, description="The property ID associated with the property access configuration.", alias="propertyId") + analytic_object_id: Optional[StrictStr] = Field(default=None, description="The analytic object ID of the property.", alias="analyticObjectId") + analytic_object_reference_paths: Optional[List[StrictStr]] = Field(default=None, description="The path to the analytic object reference. Empty if the configuration is not a reference.", alias="analyticObjectReferencePaths") + access_level: Optional[StrictStr] = Field(default=None, description="The access level of the property. Valid values are: `Aggregate`, `Detailed`. * **Aggregate**: The property can only be accessed as part of an aggregate. * **Detailed**: The property can be accessed at a detailed level.", alias="accessLevel") + property_status: Optional[StrictStr] = Field(default=None, description="The property's validity status. Valid values: `Valid`, `NoData`, `NotFound`. * **Valid**: The object exists and has loaded data. * **NoData**: The object exists but doesn't have loaded data. * **NotFound**: The object doesn't exist.", alias="propertyStatus") + __properties: ClassVar[List[str]] = ["propertyId", "analyticObjectId", "analyticObjectReferencePaths", "accessLevel", "propertyStatus"] + + @field_validator('access_level') + def access_level_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['None', 'Aggregate', 'Detailed']): + raise ValueError("must be one of enum values ('None', 'Aggregate', 'Detailed')") + return value + + @field_validator('property_status') + def property_status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unset', 'Valid', 'NoData', 'NotFound']): + raise ValueError("must be one of enum values ('Unset', 'Valid', 'NoData', 'NotFound')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPropertyAccessConfigDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPropertyAccessConfigDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "propertyId": obj.get("propertyId"), + "analyticObjectId": obj.get("analyticObjectId"), + "analyticObjectReferencePaths": obj.get("analyticObjectReferencePaths"), + "accessLevel": obj.get("accessLevel"), + "propertyStatus": obj.get("propertyStatus") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_property_set_config_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_property_set_config_dto.py new file mode 100644 index 0000000000..466ef9503a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_property_set_config_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_property_access_config_dto import ServicingPropertyAccessConfigDTO +from visier_platform_sdk.models.servicing_shareable_data_access_set import ServicingShareableDataAccessSet +from typing import Optional, Set +from typing_extensions import Self + +class ServicingPropertySetConfigDTO(BaseModel): + """ + ServicingPropertySetConfigDTO + """ # noqa: E501 + property_access_configs: Optional[List[ServicingPropertyAccessConfigDTO]] = Field(default=None, description="The data access for a property.", alias="propertyAccessConfigs") + shareable_data_access_set: Optional[ServicingShareableDataAccessSet] = Field(default=None, description="A shareable data access set. Shareable data access sets may be linked in multiple permissions.", alias="shareableDataAccessSet") + __properties: ClassVar[List[str]] = ["propertyAccessConfigs", "shareableDataAccessSet"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingPropertySetConfigDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in property_access_configs (list) + _items = [] + if self.property_access_configs: + for _item_property_access_configs in self.property_access_configs: + if _item_property_access_configs: + _items.append(_item_property_access_configs.to_dict()) + _dict['propertyAccessConfigs'] = _items + # override the default output from pydantic by calling `to_dict()` of shareable_data_access_set + if self.shareable_data_access_set: + _dict['shareableDataAccessSet'] = self.shareable_data_access_set.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingPropertySetConfigDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "propertyAccessConfigs": [ServicingPropertyAccessConfigDTO.from_dict(_item) for _item in obj["propertyAccessConfigs"]] if obj.get("propertyAccessConfigs") is not None else None, + "shareableDataAccessSet": ServicingShareableDataAccessSet.from_dict(obj["shareableDataAccessSet"]) if obj.get("shareableDataAccessSet") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_question_categories_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_question_categories_api_response_dto.py new file mode 100644 index 0000000000..a09857ae2f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_question_categories_api_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_question_category_api_response_dto import ServicingQuestionCategoryAPIResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingQuestionCategoriesAPIResponseDTO(BaseModel): + """ + ServicingQuestionCategoriesAPIResponseDTO + """ # noqa: E501 + categories: Optional[List[ServicingQuestionCategoryAPIResponseDTO]] = Field(default=None, description="A list of available categories for Vee sample questions.") + __properties: ClassVar[List[str]] = ["categories"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingQuestionCategoriesAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in categories (list) + _items = [] + if self.categories: + for _item_categories in self.categories: + if _item_categories: + _items.append(_item_categories.to_dict()) + _dict['categories'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingQuestionCategoriesAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "categories": [ServicingQuestionCategoryAPIResponseDTO.from_dict(_item) for _item in obj["categories"]] if obj.get("categories") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_question_category_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_question_category_api_response_dto.py new file mode 100644 index 0000000000..3acd33fe1d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_question_category_api_response_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingQuestionCategoryAPIResponseDTO(BaseModel): + """ + ServicingQuestionCategoryAPIResponseDTO + """ # noqa: E501 + category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the question category.", alias="categoryId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name to display within Visier. For example, \"About individuals\".", alias="displayName") + __properties: ClassVar[List[str]] = ["categoryId", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingQuestionCategoryAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingQuestionCategoryAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "categoryId": obj.get("categoryId"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_reduced_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_reduced_error_dto.py new file mode 100644 index 0000000000..3ceaa02c04 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_reduced_error_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingReducedErrorDTO(BaseModel): + """ + ServicingReducedErrorDTO + """ # noqa: E501 + error_message: Optional[StrictStr] = Field(default=None, description="A meaningful message for the end user.", alias="errorMessage") + __properties: ClassVar[List[str]] = ["errorMessage"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingReducedErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingReducedErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "errorMessage": obj.get("errorMessage") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_reduced_tenant_code_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_reduced_tenant_code_error_dto.py new file mode 100644 index 0000000000..5192331e5d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_reduced_tenant_code_error_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_reduced_error_dto import ServicingReducedErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingReducedTenantCodeErrorDTO(BaseModel): + """ + ServicingReducedTenantCodeErrorDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The bad tenant code.", alias="tenantCode") + for_all_children: Optional[StrictBool] = Field(default=None, description="If true, the assignment is for all the analytic tenants of the specified tenant.", alias="forAllChildren") + error: Optional[ServicingReducedErrorDTO] = Field(default=None, description="The details about the error.") + __properties: ClassVar[List[str]] = ["tenantCode", "forAllChildren", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingReducedTenantCodeErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of error + if self.error: + _dict['error'] = self.error.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingReducedTenantCodeErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "forAllChildren": obj.get("forAllChildren"), + "error": ServicingReducedErrorDTO.from_dict(obj["error"]) if obj.get("error") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_reduced_user_id_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_reduced_user_id_error_dto.py new file mode 100644 index 0000000000..ce078ac226 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_reduced_user_id_error_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_reduced_error_dto import ServicingReducedErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingReducedUserIdErrorDTO(BaseModel): + """ + ServicingReducedUserIdErrorDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The bad user ID.", alias="userId") + error: Optional[ServicingReducedErrorDTO] = Field(default=None, description="The details about the error.") + __properties: ClassVar[List[str]] = ["userId", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingReducedUserIdErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of error + if self.error: + _dict['error'] = self.error.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingReducedUserIdErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "error": ServicingReducedErrorDTO.from_dict(obj["error"]) if obj.get("error") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_related_analytic_object_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_related_analytic_object_dto.py new file mode 100644 index 0000000000..d0ab3ce11e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_related_analytic_object_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingRelatedAnalyticObjectDTO(BaseModel): + """ + ServicingRelatedAnalyticObjectDTO + """ # noqa: E501 + analytic_object_id: Optional[StrictStr] = Field(default=None, description="The analytic object ID.", alias="analyticObjectId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable analytic object name to display in Visier, such as \"Recognition\".", alias="displayName") + __properties: ClassVar[List[str]] = ["analyticObjectId", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingRelatedAnalyticObjectDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingRelatedAnalyticObjectDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjectId": obj.get("analyticObjectId"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_role_modules_config_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_role_modules_config_dto.py new file mode 100644 index 0000000000..54f1726f2a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_role_modules_config_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingRoleModulesConfigDTO(BaseModel): + """ + ServicingRoleModulesConfigDTO + """ # noqa: E501 + content_package_ids: Optional[List[StrictStr]] = Field(default=None, description="The unique IDs of the content packages assigned to the permission.", alias="contentPackageIds") + __properties: ClassVar[List[str]] = ["contentPackageIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingRoleModulesConfigDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingRoleModulesConfigDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "contentPackageIds": obj.get("contentPackageIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_sample_question_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_sample_question_api_response_dto.py new file mode 100644 index 0000000000..56c57b6449 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_sample_question_api_response_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_user_group_assignment_dto import ServicingUserGroupAssignmentDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingSampleQuestionAPIResponseDTO(BaseModel): + """ + ServicingSampleQuestionAPIResponseDTO + """ # noqa: E501 + question: Optional[StrictStr] = Field(default=None, description="A question in plain language.") + question_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the sample question.", alias="questionId") + visible_in_vee: Optional[StrictBool] = Field(default=None, description="If `true`, the sample question is visible in Vee.", alias="visibleInVee") + category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the question category.", alias="categoryId") + user_group_assignment: Optional[ServicingUserGroupAssignmentDTO] = Field(default=None, description="The user group IDs assigned to the sample question.", alias="userGroupAssignment") + __properties: ClassVar[List[str]] = ["question", "questionId", "visibleInVee", "categoryId", "userGroupAssignment"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingSampleQuestionAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user_group_assignment + if self.user_group_assignment: + _dict['userGroupAssignment'] = self.user_group_assignment.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingSampleQuestionAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "question": obj.get("question"), + "questionId": obj.get("questionId"), + "visibleInVee": obj.get("visibleInVee"), + "categoryId": obj.get("categoryId"), + "userGroupAssignment": ServicingUserGroupAssignmentDTO.from_dict(obj["userGroupAssignment"]) if obj.get("userGroupAssignment") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_sample_questions_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_sample_questions_api_response_dto.py new file mode 100644 index 0000000000..6caed0399d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_sample_questions_api_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_sample_question_api_response_dto import ServicingSampleQuestionAPIResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingSampleQuestionsAPIResponseDTO(BaseModel): + """ + ServicingSampleQuestionsAPIResponseDTO + """ # noqa: E501 + questions: Optional[List[ServicingSampleQuestionAPIResponseDTO]] = Field(default=None, description="A list of sample questions to help your users start using Vee.") + __properties: ClassVar[List[str]] = ["questions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingSampleQuestionsAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in questions (list) + _items = [] + if self.questions: + for _item_questions in self.questions: + if _item_questions: + _items.append(_item_questions.to_dict()) + _dict['questions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingSampleQuestionsAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "questions": [ServicingSampleQuestionAPIResponseDTO.from_dict(_item) for _item in obj["questions"]] if obj.get("questions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_securable_dimension_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_securable_dimension_dto.py new file mode 100644 index 0000000000..562223e353 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_securable_dimension_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_hierarchy_property_dto import ServicingHierarchyPropertyDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingSecurableDimensionDTO(BaseModel): + """ + ServicingSecurableDimensionDTO + """ # noqa: E501 + dimension_id: Optional[StrictStr] = Field(default=None, description="The dimension ID.", alias="dimensionId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable dimension name to display in Visier, such as \"Contract Type\".", alias="displayName") + analytic_object_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of analytic object IDs.", alias="analyticObjectIds") + hierarchy_properties: Optional[List[ServicingHierarchyPropertyDTO]] = Field(default=None, description="The list of hierarchies you can map to a user in a permission's dynamic filter.", alias="hierarchyProperties") + __properties: ClassVar[List[str]] = ["dimensionId", "displayName", "analyticObjectIds", "hierarchyProperties"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingSecurableDimensionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in hierarchy_properties (list) + _items = [] + if self.hierarchy_properties: + for _item_hierarchy_properties in self.hierarchy_properties: + if _item_hierarchy_properties: + _items.append(_item_hierarchy_properties.to_dict()) + _dict['hierarchyProperties'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingSecurableDimensionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionId": obj.get("dimensionId"), + "displayName": obj.get("displayName"), + "analyticObjectIds": obj.get("analyticObjectIds"), + "hierarchyProperties": [ServicingHierarchyPropertyDTO.from_dict(_item) for _item in obj["hierarchyProperties"]] if obj.get("hierarchyProperties") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_securable_property_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_securable_property_dto.py new file mode 100644 index 0000000000..7873c90a1c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_securable_property_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingSecurablePropertyDTO(BaseModel): + """ + ServicingSecurablePropertyDTO + """ # noqa: E501 + property_id: Optional[StrictStr] = Field(default=None, description="The property ID.", alias="propertyId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable property name to display in Visier, such as \"Job Pay Level\".", alias="displayName") + analytic_object_id: Optional[StrictStr] = Field(default=None, description="The property's analytic object ID.", alias="analyticObjectId") + is_primary_key: Optional[StrictBool] = Field(default=None, description="If true, this property is the analytic object's primary key.", alias="isPrimaryKey") + reference_symbol_name: Optional[StrictStr] = Field(default=None, description="The reference symbol name.", alias="referenceSymbolName") + __properties: ClassVar[List[str]] = ["propertyId", "displayName", "analyticObjectId", "isPrimaryKey", "referenceSymbolName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingSecurablePropertyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingSecurablePropertyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "propertyId": obj.get("propertyId"), + "displayName": obj.get("displayName"), + "analyticObjectId": obj.get("analyticObjectId"), + "isPrimaryKey": obj.get("isPrimaryKey"), + "referenceSymbolName": obj.get("referenceSymbolName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_servicing_capability_proto_enum_access_lookup_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_servicing_capability_proto_enum_access_lookup_dto.py new file mode 100644 index 0000000000..6b2fd8fc51 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_servicing_capability_proto_enum_access_lookup_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_capability_group_dto import ServicingCapabilityGroupDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingServicingCapabilityProtoEnumAccessLookupDTO(BaseModel): + """ + ServicingServicingCapabilityProtoEnumAccessLookupDTO + """ # noqa: E501 + capability_groups: Optional[List[ServicingCapabilityGroupDTO]] = Field(default=None, alias="capabilityGroups") + __properties: ClassVar[List[str]] = ["capabilityGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingServicingCapabilityProtoEnumAccessLookupDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in capability_groups (list) + _items = [] + if self.capability_groups: + for _item_capability_groups in self.capability_groups: + if _item_capability_groups: + _items.append(_item_capability_groups.to_dict()) + _dict['capabilityGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingServicingCapabilityProtoEnumAccessLookupDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "capabilityGroups": [ServicingCapabilityGroupDTO.from_dict(_item) for _item in obj["capabilityGroups"]] if obj.get("capabilityGroups") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_shareable_data_access_set.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_shareable_data_access_set.py new file mode 100644 index 0000000000..84a44b82ed --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_shareable_data_access_set.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingShareableDataAccessSet(BaseModel): + """ + ServicingShareableDataAccessSet + """ # noqa: E501 + data_access_set_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the shareable data access set.", alias="dataAccessSetId") + __properties: ClassVar[List[str]] = ["dataAccessSetId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingShareableDataAccessSet from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingShareableDataAccessSet from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataAccessSetId": obj.get("dataAccessSetId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_simple_document_header_search_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_simple_document_header_search_response_dto.py new file mode 100644 index 0000000000..393f8c1e9a --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_simple_document_header_search_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_simple_document_header_search_result_dto import ServicingSimpleDocumentHeaderSearchResultDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingSimpleDocumentHeaderSearchResponseDTO(BaseModel): + """ + The response body structure for Simple document header search operations. + """ # noqa: E501 + document_headers: Optional[List[ServicingSimpleDocumentHeaderSearchResultDTO]] = Field(default=None, description="The ordered collection of document header search results. The results are sorted according to their relevance in a descending order.", alias="documentHeaders") + __properties: ClassVar[List[str]] = ["documentHeaders"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingSimpleDocumentHeaderSearchResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in document_headers (list) + _items = [] + if self.document_headers: + for _item_document_headers in self.document_headers: + if _item_document_headers: + _items.append(_item_document_headers.to_dict()) + _dict['documentHeaders'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingSimpleDocumentHeaderSearchResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "documentHeaders": [ServicingSimpleDocumentHeaderSearchResultDTO.from_dict(_item) for _item in obj["documentHeaders"]] if obj.get("documentHeaders") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_simple_document_header_search_result_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_simple_document_header_search_result_dto.py new file mode 100644 index 0000000000..8fe13ad294 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_simple_document_header_search_result_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from visier_platform_sdk.models.servicing_document_search_link_dto import ServicingDocumentSearchLinkDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingSimpleDocumentHeaderSearchResultDTO(BaseModel): + """ + Structure of a single document header search using the Simple search operation. + """ # noqa: E501 + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the element in the search result.", alias="displayName") + description: Optional[StrictStr] = Field(default=None, description="The `Web Template Framework` representation of the search result element. This commonly displayed alongside the result by search portals.") + relevance: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The relevance of the search result and a number between `0` and `100`.") + view_link: Optional[ServicingDocumentSearchLinkDTO] = Field(default=None, description="Use the `viewLink` to build a web request to view this document.", alias="viewLink") + __properties: ClassVar[List[str]] = ["displayName", "description", "relevance", "viewLink"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingSimpleDocumentHeaderSearchResultDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of view_link + if self.view_link: + _dict['viewLink'] = self.view_link.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingSimpleDocumentHeaderSearchResultDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "displayName": obj.get("displayName"), + "description": obj.get("description"), + "relevance": obj.get("relevance"), + "viewLink": ServicingDocumentSearchLinkDTO.from_dict(obj["viewLink"]) if obj.get("viewLink") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_sources_api_operation_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_sources_api_operation_request_dto.py new file mode 100644 index 0000000000..3e787efbf6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_sources_api_operation_request_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingSourcesAPIOperationRequestDTO(BaseModel): + """ + ServicingSourcesAPIOperationRequestDTO + """ # noqa: E501 + operation: Optional[StrictStr] = Field(default=None, description="The operation to perform. Valid values: * `exportSources`: Export all sources from the tenant. If successful, a ZIP file is returned containing a compressed JSON file with the sources.") + __properties: ClassVar[List[str]] = ["operation"] + + @field_validator('operation') + def operation_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['unknownSourcesAPIOperation', 'exportSources']): + raise ValueError("must be one of enum values ('unknownSourcesAPIOperation', 'exportSources')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingSourcesAPIOperationRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingSourcesAPIOperationRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "operation": obj.get("operation") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_static_dimension_filter_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_static_dimension_filter_dto.py new file mode 100644 index 0000000000..ade6307be7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_static_dimension_filter_dto.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_member_selection_dto import ServicingMemberSelectionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingStaticDimensionFilterDTO(BaseModel): + """ + ServicingStaticDimensionFilterDTO + """ # noqa: E501 + dimension_id: Optional[StrictStr] = Field(default=None, description="The dimension ID associated with the filter.", alias="dimensionId") + subject_reference_path: Optional[List[StrictStr]] = Field(default=None, description="The subject reference path.", alias="subjectReferencePath") + member_selections: Optional[List[ServicingMemberSelectionDTO]] = Field(default=None, description="A list of objects representing the dimension members assigned population access in the member filter.", alias="memberSelections") + dimension_status: Optional[StrictStr] = Field(default=None, description="The dimension's validity status. Valid values: Valid, NoData, NotFound. * **Valid**: The object exists and has loaded data. * **NoData**: The object exists but doesn't have loaded data. * **NotFound**: The object doesn't exist.", alias="dimensionStatus") + __properties: ClassVar[List[str]] = ["dimensionId", "subjectReferencePath", "memberSelections", "dimensionStatus"] + + @field_validator('dimension_status') + def dimension_status_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Unset', 'Valid', 'NoData', 'NotFound']): + raise ValueError("must be one of enum values ('Unset', 'Valid', 'NoData', 'NotFound')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingStaticDimensionFilterDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in member_selections (list) + _items = [] + if self.member_selections: + for _item_member_selections in self.member_selections: + if _item_member_selections: + _items.append(_item_member_selections.to_dict()) + _dict['memberSelections'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingStaticDimensionFilterDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dimensionId": obj.get("dimensionId"), + "subjectReferencePath": obj.get("subjectReferencePath"), + "memberSelections": [ServicingMemberSelectionDTO.from_dict(_item) for _item in obj["memberSelections"]] if obj.get("memberSelections") is not None else None, + "dimensionStatus": obj.get("dimensionStatus") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_successful_accessible_tenant_profile_assignment_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_successful_accessible_tenant_profile_assignment_dto.py new file mode 100644 index 0000000000..04b569d5cd --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_successful_accessible_tenant_profile_assignment_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingSuccessfulAccessibleTenantProfileAssignmentDTO(BaseModel): + """ + ServicingSuccessfulAccessibleTenantProfileAssignmentDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The user ID.", alias="userId") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code.", alias="tenantCode") + for_all_children: Optional[StrictBool] = Field(default=None, description="If true, the target assignment is for all analytic tenants.", alias="forAllChildren") + __properties: ClassVar[List[str]] = ["userId", "tenantCode", "forAllChildren"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingSuccessfulAccessibleTenantProfileAssignmentDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingSuccessfulAccessibleTenantProfileAssignmentDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "tenantCode": obj.get("tenantCode"), + "forAllChildren": obj.get("forAllChildren") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_successful_local_tenant_profile_assignment_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_successful_local_tenant_profile_assignment_dto.py new file mode 100644 index 0000000000..6f6ec5c707 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_successful_local_tenant_profile_assignment_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingSuccessfulLocalTenantProfileAssignmentDTO(BaseModel): + """ + ServicingSuccessfulLocalTenantProfileAssignmentDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The user ID.", alias="userId") + __properties: ClassVar[List[str]] = ["userId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingSuccessfulLocalTenantProfileAssignmentDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingSuccessfulLocalTenantProfileAssignmentDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_target_tenant_code_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_target_tenant_code_dto.py new file mode 100644 index 0000000000..f441498528 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_target_tenant_code_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingTargetTenantCodeDTO(BaseModel): + """ + ServicingTargetTenantCodeDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code.", alias="tenantCode") + for_all_children: Optional[StrictBool] = Field(default=None, description="If true, the assignment is for all the analytic tenants of the specified tenant.", alias="forAllChildren") + __properties: ClassVar[List[str]] = ["tenantCode", "forAllChildren"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingTargetTenantCodeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingTargetTenantCodeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "forAllChildren": obj.get("forAllChildren") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_code_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_code_error_dto.py new file mode 100644 index 0000000000..a6eac2899c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_code_error_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_error_dto import ServicingErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingTenantCodeErrorDTO(BaseModel): + """ + ServicingTenantCodeErrorDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The bad tenant code.", alias="tenantCode") + for_all_children: Optional[StrictBool] = Field(default=None, description="If true, the target assignment is for all analytic tenants.", alias="forAllChildren") + error: Optional[ServicingErrorDTO] = Field(default=None, description="The details about the error.") + __properties: ClassVar[List[str]] = ["tenantCode", "forAllChildren", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingTenantCodeErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of error + if self.error: + _dict['error'] = self.error.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingTenantCodeErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "forAllChildren": obj.get("forAllChildren"), + "error": ServicingErrorDTO.from_dict(obj["error"]) if obj.get("error") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_upload_status_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_upload_status_response_dto.py new file mode 100644 index 0000000000..3c2cab2244 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_upload_status_response_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingTenantDataUploadStatusResponseDTO(BaseModel): + """ + ServicingTenantDataUploadStatusResponseDTO + """ # noqa: E501 + upload_time: Optional[StrictStr] = Field(default=None, description="The upload time of the data upload.", alias="uploadTime") + included: Optional[StrictBool] = Field(default=None, description="If \"true\", the data upload is included.") + __properties: ClassVar[List[str]] = ["uploadTime", "included"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingTenantDataUploadStatusResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingTenantDataUploadStatusResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uploadTime": obj.get("uploadTime"), + "included": obj.get("included") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_upload_update_status_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_upload_update_status_response_dto.py new file mode 100644 index 0000000000..628d6f0680 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_upload_update_status_response_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingTenantDataUploadUpdateStatusResponseDTO(BaseModel): + """ + ServicingTenantDataUploadUpdateStatusResponseDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The analytic tenant that the exclusion operation was conducted for.", alias="tenantCode") + upload_time: Optional[StrictStr] = Field(default=None, description="The upload time of the data upload", alias="uploadTime") + status: Optional[StrictStr] = Field(default=None, description="The outcome of the exclusion operation.") + message: Optional[StrictStr] = Field(default=None, description="If applicable, the message explains why errors were encountered during the exclusion operation.") + __properties: ClassVar[List[str]] = ["tenantCode", "uploadTime", "status", "message"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingTenantDataUploadUpdateStatusResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingTenantDataUploadUpdateStatusResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "uploadTime": obj.get("uploadTime"), + "status": obj.get("status"), + "message": obj.get("message") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_uploads_list_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_uploads_list_response_dto.py new file mode 100644 index 0000000000..1cd3dd5c6b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_uploads_list_response_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_tenant_data_uploads_response_dto import ServicingTenantDataUploadsResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingTenantDataUploadsListResponseDTO(BaseModel): + """ + ServicingTenantDataUploadsListResponseDTO + """ # noqa: E501 + tenants: Optional[List[ServicingTenantDataUploadsResponseDTO]] = Field(default=None, description="A list of objects representing analytic tenants and their data uploads.") + limit: Optional[StrictInt] = Field(default=None, description="The number of analytic tenants to retrieve. The maximum number of analytic tenants to retrieve is 1000.") + start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving results from, also known as offset. The index begins at 0.") + __properties: ClassVar[List[str]] = ["tenants", "limit", "start"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingTenantDataUploadsListResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tenants (list) + _items = [] + if self.tenants: + for _item_tenants in self.tenants: + if _item_tenants: + _items.append(_item_tenants.to_dict()) + _dict['tenants'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingTenantDataUploadsListResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenants": [ServicingTenantDataUploadsResponseDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None, + "limit": obj.get("limit"), + "start": obj.get("start") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_uploads_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_uploads_response_dto.py new file mode 100644 index 0000000000..ef9b39bf68 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_uploads_response_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_tenant_data_upload_status_response_dto import ServicingTenantDataUploadStatusResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingTenantDataUploadsResponseDTO(BaseModel): + """ + ServicingTenantDataUploadsResponseDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant owning the data uploads.", alias="tenantCode") + uploads: Optional[List[ServicingTenantDataUploadStatusResponseDTO]] = Field(default=None, description="The data uploads completed for the specified analytic tenant. The list is empty if no previous data uploads are found for the analytic tenant.") + __properties: ClassVar[List[str]] = ["tenantCode", "uploads"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingTenantDataUploadsResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in uploads (list) + _items = [] + if self.uploads: + for _item_uploads in self.uploads: + if _item_uploads: + _items.append(_item_uploads.to_dict()) + _dict['uploads'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingTenantDataUploadsResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "uploads": [ServicingTenantDataUploadStatusResponseDTO.from_dict(_item) for _item in obj["uploads"]] if obj.get("uploads") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_uploads_update_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_uploads_update_response_dto.py new file mode 100644 index 0000000000..4bdff87cf3 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_tenant_data_uploads_update_response_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_tenant_data_upload_update_status_response_dto import ServicingTenantDataUploadUpdateStatusResponseDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingTenantDataUploadsUpdateResponseDTO(BaseModel): + """ + ServicingTenantDataUploadsUpdateResponseDTO + """ # noqa: E501 + total_failures: Optional[StrictInt] = Field(default=None, description="The number of data uploads that failed during the exclusion operation.", alias="totalFailures") + total_success: Optional[StrictInt] = Field(default=None, description="The number of data uploads that were excluded successfully.", alias="totalSuccess") + uploads: Optional[List[ServicingTenantDataUploadUpdateStatusResponseDTO]] = Field(default=None, description="A list of objects representing the results of the data upload exclusion.") + __properties: ClassVar[List[str]] = ["totalFailures", "totalSuccess", "uploads"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingTenantDataUploadsUpdateResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in uploads (list) + _items = [] + if self.uploads: + for _item_uploads in self.uploads: + if _item_uploads: + _items.append(_item_uploads.to_dict()) + _dict['uploads'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingTenantDataUploadsUpdateResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "totalFailures": obj.get("totalFailures"), + "totalSuccess": obj.get("totalSuccess"), + "uploads": [ServicingTenantDataUploadUpdateStatusResponseDTO.from_dict(_item) for _item in obj["uploads"]] if obj.get("uploads") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_creation_api_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_creation_api_request_dto.py new file mode 100644 index 0000000000..db4b34cd3c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_creation_api_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUserCreationAPIRequestDTO(BaseModel): + """ + ServicingUserCreationAPIRequestDTO + """ # noqa: E501 + username: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@visier.com.") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name to display within Visier. For example, \"John Smith\".", alias="displayName") + employee_id: Optional[StrictStr] = Field(default=None, description="If applicable, and if available, the user employee ID in the data.", alias="employeeId") + account_enabled: Optional[StrictStr] = Field(default=None, description="If false, the user account is disabled.", alias="accountEnabled") + email: Optional[StrictStr] = Field(default=None, description="The user's email. This is used if the user's email is different from their username. For example, \"john.doe@visier.com\".") + __properties: ClassVar[List[str]] = ["username", "displayName", "employeeId", "accountEnabled", "email"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUserCreationAPIRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUserCreationAPIRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "username": obj.get("username"), + "displayName": obj.get("displayName"), + "employeeId": obj.get("employeeId"), + "accountEnabled": obj.get("accountEnabled"), + "email": obj.get("email") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_get_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_get_api_response_dto.py new file mode 100644 index 0000000000..8910ab40b8 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_get_api_response_dto.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_all_permissions_assigned_for_local_tenant_dto import ServicingAllPermissionsAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_all_profile_assigned_for_local_tenant_dto import ServicingAllProfileAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_all_user_groups_assigned_for_local_tenant_dto import ServicingAllUserGroupsAssignedForLocalTenantDTO +from visier_platform_sdk.models.servicing_last_login_dto import ServicingLastLoginDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUserGetAPIResponseDTO(BaseModel): + """ + ServicingUserGetAPIResponseDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user.", alias="userId") + username: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@jupiter.com.") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name to display within Visier. For example, \"John Smith\".", alias="displayName") + employee_id: Optional[StrictStr] = Field(default=None, description="If applicable, and if available, the user employee ID in the data.", alias="employeeId") + account_enabled: Optional[StrictBool] = Field(default=None, description="If false, the user account is disabled.", alias="accountEnabled") + profiles: Optional[ServicingAllProfileAssignedForLocalTenantDTO] = Field(default=None, description="A list of objects representing the list of available profiles. Not returned if the user has no profiles.") + permissions: Optional[ServicingAllPermissionsAssignedForLocalTenantDTO] = Field(default=None, description="A list of objects representing the user's permissions.") + user_groups: Optional[ServicingAllUserGroupsAssignedForLocalTenantDTO] = Field(default=None, description="A list of objects representing the available user groups.", alias="userGroups") + last_login: Optional[ServicingLastLoginDTO] = Field(default=None, description="An object that represents the time that the user last logged into Visier.", alias="lastLogin") + email: Optional[StrictStr] = Field(default=None, description="The user's email address.") + __properties: ClassVar[List[str]] = ["userId", "username", "displayName", "employeeId", "accountEnabled", "profiles", "permissions", "userGroups", "lastLogin", "email"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUserGetAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of profiles + if self.profiles: + _dict['profiles'] = self.profiles.to_dict() + # override the default output from pydantic by calling `to_dict()` of permissions + if self.permissions: + _dict['permissions'] = self.permissions.to_dict() + # override the default output from pydantic by calling `to_dict()` of user_groups + if self.user_groups: + _dict['userGroups'] = self.user_groups.to_dict() + # override the default output from pydantic by calling `to_dict()` of last_login + if self.last_login: + _dict['lastLogin'] = self.last_login.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUserGetAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "username": obj.get("username"), + "displayName": obj.get("displayName"), + "employeeId": obj.get("employeeId"), + "accountEnabled": obj.get("accountEnabled"), + "profiles": ServicingAllProfileAssignedForLocalTenantDTO.from_dict(obj["profiles"]) if obj.get("profiles") is not None else None, + "permissions": ServicingAllPermissionsAssignedForLocalTenantDTO.from_dict(obj["permissions"]) if obj.get("permissions") is not None else None, + "userGroups": ServicingAllUserGroupsAssignedForLocalTenantDTO.from_dict(obj["userGroups"]) if obj.get("userGroups") is not None else None, + "lastLogin": ServicingLastLoginDTO.from_dict(obj["lastLogin"]) if obj.get("lastLogin") is not None else None, + "email": obj.get("email") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_group_assigned_for_local_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_group_assigned_for_local_tenant_dto.py new file mode 100644 index 0000000000..c87ae1673b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_group_assigned_for_local_tenant_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUserGroupAssignedForLocalTenantDTO(BaseModel): + """ + ServicingUserGroupAssignedForLocalTenantDTO + """ # noqa: E501 + user_group_id: Optional[StrictStr] = Field(default=None, description="The user group ID.", alias="userGroupId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable user group name to display in Visier, such as \"Leadership User Group\".", alias="displayName") + __properties: ClassVar[List[str]] = ["userGroupId", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUserGroupAssignedForLocalTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUserGroupAssignedForLocalTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroupId": obj.get("userGroupId"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_group_assignment_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_group_assignment_dto.py new file mode 100644 index 0000000000..c8d49e9aaa --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_group_assignment_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUserGroupAssignmentDTO(BaseModel): + """ + ServicingUserGroupAssignmentDTO + """ # noqa: E501 + user_group_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of user group IDs assigned to the sample question.", alias="userGroupIds") + __properties: ClassVar[List[str]] = ["userGroupIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUserGroupAssignmentDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUserGroupAssignmentDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userGroupIds": obj.get("userGroupIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_id_error_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_id_error_dto.py new file mode 100644 index 0000000000..443d042904 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_id_error_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_error_dto import ServicingErrorDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUserIdErrorDTO(BaseModel): + """ + ServicingUserIdErrorDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The bad user ID.", alias="userId") + error: Optional[ServicingErrorDTO] = Field(default=None, description="The details about the error.") + __properties: ClassVar[List[str]] = ["userId", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUserIdErrorDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of error + if self.error: + _dict['error'] = self.error.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUserIdErrorDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "error": ServicingErrorDTO.from_dict(obj["error"]) if obj.get("error") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_property_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_property_dto.py new file mode 100644 index 0000000000..738125f4f1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_property_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUserPropertyDTO(BaseModel): + """ + ServicingUserPropertyDTO + """ # noqa: E501 + name: Optional[StrictStr] = Field(default=None, description="The name property to map to in the dynamic filter. Valid values are one of `username`, `email`, `employeeId`.") + __properties: ClassVar[List[str]] = ["name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUserPropertyDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUserPropertyDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_update_api_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_update_api_request_dto.py new file mode 100644 index 0000000000..465b44a979 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_user_update_api_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUserUpdateAPIRequestDTO(BaseModel): + """ + ServicingUserUpdateAPIRequestDTO + """ # noqa: E501 + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name to display within Visier. For example, \"John Smith\".", alias="displayName") + employee_id: Optional[StrictStr] = Field(default=None, description="If applicable, and if available, the user employee ID in the data.", alias="employeeId") + account_enabled: Optional[StrictStr] = Field(default=None, description="If true, the user account is enabled.", alias="accountEnabled") + email: Optional[StrictStr] = Field(default=None, description="The user's email address.") + username: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@jupiter.com. If a user's username changes, they must authenticate using the new username.") + __properties: ClassVar[List[str]] = ["displayName", "employeeId", "accountEnabled", "email", "username"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUserUpdateAPIRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUserUpdateAPIRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "displayName": obj.get("displayName"), + "employeeId": obj.get("employeeId"), + "accountEnabled": obj.get("accountEnabled"), + "email": obj.get("email"), + "username": obj.get("username") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_error_message_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_error_message_dto.py new file mode 100644 index 0000000000..7de278e260 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_error_message_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUsersAPIErrorMessageDTO(BaseModel): + """ + ServicingUsersAPIErrorMessageDTO + """ # noqa: E501 + message: Optional[StrictStr] = Field(default=None, description="Error message") + rci: Optional[StrictStr] = Field(default=None, description="The unique identifier associated to this error") + __properties: ClassVar[List[str]] = ["message", "rci"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUsersAPIErrorMessageDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUsersAPIErrorMessageDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "message": obj.get("message"), + "rci": obj.get("rci") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_failure_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_failure_dto.py new file mode 100644 index 0000000000..965d1213aa --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_failure_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_users_api_error_message_dto import ServicingUsersAPIErrorMessageDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUsersAPIFailureDTO(BaseModel): + """ + ServicingUsersAPIFailureDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user.", alias="userId") + user_name: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@jupiter.com.", alias="userName") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name to display within Visier. For example, \"John Smith\".", alias="displayName") + error: Optional[ServicingUsersAPIErrorMessageDTO] = Field(default=None, description="The error thrown during creation.") + __properties: ClassVar[List[str]] = ["userId", "userName", "displayName", "error"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUsersAPIFailureDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of error + if self.error: + _dict['error'] = self.error.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUsersAPIFailureDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "userName": obj.get("userName"), + "displayName": obj.get("displayName"), + "error": ServicingUsersAPIErrorMessageDTO.from_dict(obj["error"]) if obj.get("error") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_response_dto.py new file mode 100644 index 0000000000..e430050024 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_users_api_failure_dto import ServicingUsersAPIFailureDTO +from visier_platform_sdk.models.servicing_users_api_success_dto import ServicingUsersAPISuccessDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUsersAPIResponseDTO(BaseModel): + """ + ServicingUsersAPIResponseDTO + """ # noqa: E501 + successes: Optional[List[ServicingUsersAPISuccessDTO]] = Field(default=None, description="The users for which the request succeeded.") + failures: Optional[List[ServicingUsersAPIFailureDTO]] = Field(default=None, description="The users for which the request failed.") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUsersAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUsersAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [ServicingUsersAPISuccessDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [ServicingUsersAPIFailureDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_success_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_success_dto.py new file mode 100644 index 0000000000..fa8f72df1f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_api_success_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUsersAPISuccessDTO(BaseModel): + """ + ServicingUsersAPISuccessDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user.", alias="userId") + username: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@jupiter.com.") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name to display within Visier. For example, \"John Smith\".", alias="displayName") + employee_id: Optional[StrictStr] = Field(default=None, description="If applicable, and if available, the user employee ID in the data.", alias="employeeId") + account_enabled: Optional[StrictStr] = Field(default=None, description="If true, the user account is enabled.", alias="accountEnabled") + email: Optional[StrictStr] = Field(default=None, description="The user's email address.") + __properties: ClassVar[List[str]] = ["userId", "username", "displayName", "employeeId", "accountEnabled", "email"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUsersAPISuccessDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUsersAPISuccessDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "username": obj.get("username"), + "displayName": obj.get("displayName"), + "employeeId": obj.get("employeeId"), + "accountEnabled": obj.get("accountEnabled"), + "email": obj.get("email") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_creation_api_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_creation_api_request_dto.py new file mode 100644 index 0000000000..daedd787ed --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_creation_api_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_user_creation_api_request_dto import ServicingUserCreationAPIRequestDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUsersCreationAPIRequestDTO(BaseModel): + """ + ServicingUsersCreationAPIRequestDTO + """ # noqa: E501 + users: Optional[List[ServicingUserCreationAPIRequestDTO]] = Field(default=None, description="A list of objects representing users to create. Maximum 100 users can be created in a single request.") + __properties: ClassVar[List[str]] = ["users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUsersCreationAPIRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUsersCreationAPIRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "users": [ServicingUserCreationAPIRequestDTO.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_delete_api_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_delete_api_request_dto.py new file mode 100644 index 0000000000..78df85b1fd --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_delete_api_request_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUsersDeleteAPIRequestDTO(BaseModel): + """ + ServicingUsersDeleteAPIRequestDTO + """ # noqa: E501 + user_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of objects representing users to delete. Maximum 100 users can be deleted in a single request.", alias="userIds") + __properties: ClassVar[List[str]] = ["userIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUsersDeleteAPIRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUsersDeleteAPIRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userIds": obj.get("userIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_update_api_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_update_api_request_dto.py new file mode 100644 index 0000000000..07b81e119f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_update_api_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_users_update_api_user_dto import ServicingUsersUpdateAPIUserDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUsersUpdateAPIRequestDTO(BaseModel): + """ + ServicingUsersUpdateAPIRequestDTO + """ # noqa: E501 + users: Optional[List[ServicingUsersUpdateAPIUserDTO]] = Field(default=None, description="A list of objects representing users to update. Maximum 100 users can be updated in a single request.") + __properties: ClassVar[List[str]] = ["users"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUsersUpdateAPIRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in users (list) + _items = [] + if self.users: + for _item_users in self.users: + if _item_users: + _items.append(_item_users.to_dict()) + _dict['users'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUsersUpdateAPIRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "users": [ServicingUsersUpdateAPIUserDTO.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_update_api_user_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_update_api_user_dto.py new file mode 100644 index 0000000000..8d81450a24 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_users_update_api_user_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingUsersUpdateAPIUserDTO(BaseModel): + """ + ServicingUsersUpdateAPIUserDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user.", alias="userId") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name to display within Visier. For example, \"John Smith\".", alias="displayName") + employee_id: Optional[StrictStr] = Field(default=None, description="If applicable, and if available, the user employee ID in the data.", alias="employeeId") + account_enabled: Optional[StrictStr] = Field(default=None, description="If true, the user account is enabled.", alias="accountEnabled") + email: Optional[StrictStr] = Field(default=None, description="The user's email address.") + username: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@jupiter.com. If a user's username changes, they must authenticate using the new username.") + __properties: ClassVar[List[str]] = ["userId", "displayName", "employeeId", "accountEnabled", "email", "username"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingUsersUpdateAPIUserDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingUsersUpdateAPIUserDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "displayName": obj.get("displayName"), + "employeeId": obj.get("employeeId"), + "accountEnabled": obj.get("accountEnabled"), + "email": obj.get("email"), + "username": obj.get("username") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_definition_dto.py new file mode 100644 index 0000000000..988a0c6155 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_definition_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO(BaseModel): + """ + Information about the analytic object, such as its UUID and object name. + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The UUID identifying the analytic object.") + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the analytic object.", alias="objectName") + update_operation: Optional[StrictStr] = Field(default=None, description="Update the analytic object. Required for `PUT` requests. Valid values: - `unspecified`: Do not update the object. - `revertToBP`: Undo any tenant overrides and revert the object back to its Blueprint state.", alias="updateOperation") + __properties: ClassVar[List[str]] = ["uuid", "objectName", "updateOperation"] + + @field_validator('update_operation') + def update_operation_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['unspecified', 'revertToBP']): + raise ValueError("must be one of enum values ('unspecified', 'revertToBP')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "objectName": obj.get("objectName"), + "updateOperation": obj.get("updateOperation") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_request_dto.py new file mode 100644 index 0000000000..733f30745c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_with_context_dto import ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationAnalyticObjectRequestDTO(BaseModel): + """ + The analytic objects to create or update. + """ # noqa: E501 + analytic_objects: Optional[List[ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO]] = Field(default=None, description="The analytic objects in the request.", alias="analyticObjects") + __properties: ClassVar[List[str]] = ["analyticObjects"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationAnalyticObjectRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in analytic_objects (list) + _items = [] + if self.analytic_objects: + for _item_analytic_objects in self.analytic_objects: + if _item_analytic_objects: + _items.append(_item_analytic_objects.to_dict()) + _dict['analyticObjects'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationAnalyticObjectRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjects": [ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO.from_dict(_item) for _item in obj["analyticObjects"]] if obj.get("analyticObjects") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_with_context_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_with_context_dto.py new file mode 100644 index 0000000000..9e59c3eb7e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_with_context_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_analytic_object_definition_dto import ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_execution_context_dto import ServicingV2ObjectconfigurationExecutionContextDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO(BaseModel): + """ + Information about the analytic object and the context of the API request, such as the tenant code and project ID. + """ # noqa: E501 + execution_context: Optional[ServicingV2ObjectconfigurationExecutionContextDTO] = Field(default=None, description="The context of the API request, such as the tenant code and project ID.", alias="executionContext") + analytic_object: Optional[ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO] = Field(default=None, description="Information about the analytic object, such as its UUID and object name.", alias="analyticObject") + __properties: ClassVar[List[str]] = ["executionContext", "analyticObject"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of execution_context + if self.execution_context: + _dict['executionContext'] = self.execution_context.to_dict() + # override the default output from pydantic by calling `to_dict()` of analytic_object + if self.analytic_object: + _dict['analyticObject'] = self.analytic_object.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationAnalyticObjectWithContextDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "executionContext": ServicingV2ObjectconfigurationExecutionContextDTO.from_dict(obj["executionContext"]) if obj.get("executionContext") is not None else None, + "analyticObject": ServicingV2ObjectconfigurationAnalyticObjectDefinitionDTO.from_dict(obj["analyticObject"]) if obj.get("analyticObject") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_basic_information_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_basic_information_dto.py new file mode 100644 index 0000000000..ff0b13813c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_basic_information_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_synonym_list_dto import ServicingV2ObjectconfigurationSynonymListDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationBasicInformationDTO(BaseModel): + """ + Fields that identify and describe the object, such as its display name, description, and explanation. + """ # noqa: E501 + display_name: Optional[StrictStr] = Field(default=None, description="The user-friendly name for the object.", alias="displayName") + short_display_name: Optional[StrictStr] = Field(default=None, description="A shortened version of the display name. If the object is visible in the solution experience, this name is displayed in visualization titles.", alias="shortDisplayName") + description: Optional[StrictStr] = Field(default=None, description="A short description of the object. Descriptions provide in-context help for your users while working in Visier.") + explanation: Optional[StrictStr] = Field(default=None, description="A longer description of the object that typically includes a definition, calculation details, and other guidance about how to use the object.") + designer_notes: Optional[StrictStr] = Field(default=None, description="An admin-only description of the object that provides design-specific information or considerations.", alias="designerNotes") + synonym_list: Optional[ServicingV2ObjectconfigurationSynonymListDTO] = Field(default=None, description="Alternative words or phrases for the object.", alias="synonymList") + __properties: ClassVar[List[str]] = ["displayName", "shortDisplayName", "description", "explanation", "designerNotes", "synonymList"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationBasicInformationDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of synonym_list + if self.synonym_list: + _dict['synonymList'] = self.synonym_list.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationBasicInformationDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "displayName": obj.get("displayName"), + "shortDisplayName": obj.get("shortDisplayName"), + "description": obj.get("description"), + "explanation": obj.get("explanation"), + "designerNotes": obj.get("designerNotes"), + "synonymList": ServicingV2ObjectconfigurationSynonymListDTO.from_dict(obj["synonymList"]) if obj.get("synonymList") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_bulk_change_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_bulk_change_response_dto.py new file mode 100644 index 0000000000..d11c883996 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_bulk_change_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_failed_change_dto import ServicingV2ObjectconfigurationFailedChangeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_successful_change_dto import ServicingV2ObjectconfigurationSuccessfulChangeDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationBulkChangeResponseDTO(BaseModel): + """ + ServicingV2ObjectconfigurationBulkChangeResponseDTO + """ # noqa: E501 + successes: Optional[List[ServicingV2ObjectconfigurationSuccessfulChangeDTO]] = Field(default=None, description="The list of successful changes.") + failures: Optional[List[ServicingV2ObjectconfigurationFailedChangeDTO]] = Field(default=None, description="The list of failed changes.") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationBulkChangeResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationBulkChangeResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [ServicingV2ObjectconfigurationSuccessfulChangeDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [ServicingV2ObjectconfigurationFailedChangeDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_calculated_property_type_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_calculated_property_type_dto.py new file mode 100644 index 0000000000..2375b92836 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_calculated_property_type_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO(BaseModel): + """ + A calculated property that takes a value that comes directly from the data and creates a new value through a formula. + """ # noqa: E501 + data_type: Optional[StrictStr] = Field(default=None, description="The property's data type. Valid values: `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`, `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`, `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`.", alias="dataType") + primitive_type: Optional[StrictStr] = Field(default=None, description="The primitive data type, such as String, Integer, or Boolean.", alias="primitiveType") + formula: Optional[StrictStr] = Field(default=None, description="The property's formula written in Visier Formula Language (VFL).") + __properties: ClassVar[List[str]] = ["dataType", "primitiveType", "formula"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataType": obj.get("dataType"), + "primitiveType": obj.get("primitiveType"), + "formula": obj.get("formula") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_definition_dto.py new file mode 100644 index 0000000000..afb43c9a82 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_definition_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_basic_information_dto import ServicingV2ObjectconfigurationBasicInformationDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_type_details_dto import ServicingV2ObjectconfigurationConceptTypeDetailsDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationConceptDefinitionDTO(BaseModel): + """ + Information about the concept, such as its UUID and concept type. + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The UUID identifying the concept.") + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the concept.", alias="objectName") + basic_information: Optional[ServicingV2ObjectconfigurationBasicInformationDTO] = Field(default=None, description="Fields that identify and describe the concept, such as its display name, description, and explanation.", alias="basicInformation") + details: Optional[ServicingV2ObjectconfigurationConceptTypeDetailsDTO] = Field(default=None, description="The concept type and its details.") + __properties: ClassVar[List[str]] = ["uuid", "objectName", "basicInformation", "details"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of basic_information + if self.basic_information: + _dict['basicInformation'] = self.basic_information.to_dict() + # override the default output from pydantic by calling `to_dict()` of details + if self.details: + _dict['details'] = self.details.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "objectName": obj.get("objectName"), + "basicInformation": ServicingV2ObjectconfigurationBasicInformationDTO.from_dict(obj["basicInformation"]) if obj.get("basicInformation") is not None else None, + "details": ServicingV2ObjectconfigurationConceptTypeDetailsDTO.from_dict(obj["details"]) if obj.get("details") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_request_dto.py new file mode 100644 index 0000000000..cf37b01189 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_delete_with_context_dto import ServicingV2ObjectconfigurationConceptDeleteWithContextDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationConceptDeleteRequestDTO(BaseModel): + """ + The concepts to delete. + """ # noqa: E501 + concepts: Optional[List[ServicingV2ObjectconfigurationConceptDeleteWithContextDTO]] = Field(default=None, description="The concepts in the request.") + __properties: ClassVar[List[str]] = ["concepts"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptDeleteRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in concepts (list) + _items = [] + if self.concepts: + for _item_concepts in self.concepts: + if _item_concepts: + _items.append(_item_concepts.to_dict()) + _dict['concepts'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptDeleteRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "concepts": [ServicingV2ObjectconfigurationConceptDeleteWithContextDTO.from_dict(_item) for _item in obj["concepts"]] if obj.get("concepts") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_with_context_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_with_context_dto.py new file mode 100644 index 0000000000..2322ff0e7b --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_with_context_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_execution_context_dto import ServicingV2ObjectconfigurationExecutionContextDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_object_id_dto import ServicingV2ObjectconfigurationObjectIdDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationConceptDeleteWithContextDTO(BaseModel): + """ + Information about the concept to delete and the context of the API request, such as the tenant code and project ID. + """ # noqa: E501 + execution_context: Optional[ServicingV2ObjectconfigurationExecutionContextDTO] = Field(default=None, description="The context of the API request, such as the tenant code and project ID.", alias="executionContext") + concept: Optional[ServicingV2ObjectconfigurationObjectIdDTO] = Field(default=None, description="Information identifying the concept to delete.") + __properties: ClassVar[List[str]] = ["executionContext", "concept"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptDeleteWithContextDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of execution_context + if self.execution_context: + _dict['executionContext'] = self.execution_context.to_dict() + # override the default output from pydantic by calling `to_dict()` of concept + if self.concept: + _dict['concept'] = self.concept.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptDeleteWithContextDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "executionContext": ServicingV2ObjectconfigurationExecutionContextDTO.from_dict(obj["executionContext"]) if obj.get("executionContext") is not None else None, + "concept": ServicingV2ObjectconfigurationObjectIdDTO.from_dict(obj["concept"]) if obj.get("concept") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_request_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_request_dto.py new file mode 100644 index 0000000000..bedfe7425e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_request_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_with_context_dto import ServicingV2ObjectconfigurationConceptWithContextDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationConceptRequestDTO(BaseModel): + """ + The concepts to create or update. + """ # noqa: E501 + concepts: Optional[List[ServicingV2ObjectconfigurationConceptWithContextDTO]] = Field(default=None, description="The concepts in the request.") + __properties: ClassVar[List[str]] = ["concepts"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptRequestDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in concepts (list) + _items = [] + if self.concepts: + for _item_concepts in self.concepts: + if _item_concepts: + _items.append(_item_concepts.to_dict()) + _dict['concepts'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptRequestDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "concepts": [ServicingV2ObjectconfigurationConceptWithContextDTO.from_dict(_item) for _item in obj["concepts"]] if obj.get("concepts") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_response_dto.py new file mode 100644 index 0000000000..6b9f3c894d --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_response_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_with_context_dto import ServicingV2ObjectconfigurationConceptWithContextDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationConceptResponseDTO(BaseModel): + """ + The response for retrieving concepts. + """ # noqa: E501 + concepts: Optional[List[ServicingV2ObjectconfigurationConceptWithContextDTO]] = Field(default=None, description="The concepts in the response.") + __properties: ClassVar[List[str]] = ["concepts"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in concepts (list) + _items = [] + if self.concepts: + for _item_concepts in self.concepts: + if _item_concepts: + _items.append(_item_concepts.to_dict()) + _dict['concepts'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "concepts": [ServicingV2ObjectconfigurationConceptWithContextDTO.from_dict(_item) for _item in obj["concepts"]] if obj.get("concepts") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_type_details_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_type_details_dto.py new file mode 100644 index 0000000000..9e19458b1e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_type_details_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_definition_dto import ServicingV2ObjectconfigurationProcessConceptDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationConceptTypeDetailsDTO(BaseModel): + """ + ServicingV2ObjectconfigurationConceptTypeDetailsDTO + """ # noqa: E501 + process: Optional[ServicingV2ObjectconfigurationProcessConceptDefinitionDTO] = Field(default=None, description="The process concept's associated objects, such as its analytic object and status dimension.") + __properties: ClassVar[List[str]] = ["process"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptTypeDetailsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of process + if self.process: + _dict['process'] = self.process.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptTypeDetailsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "process": ServicingV2ObjectconfigurationProcessConceptDefinitionDTO.from_dict(obj["process"]) if obj.get("process") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_with_context_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_with_context_dto.py new file mode 100644 index 0000000000..ee38eb6693 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_with_context_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_concept_definition_dto import ServicingV2ObjectconfigurationConceptDefinitionDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_execution_context_dto import ServicingV2ObjectconfigurationExecutionContextDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationConceptWithContextDTO(BaseModel): + """ + Information about the concept and the context of the API request, such as the tenant code and project ID. + """ # noqa: E501 + execution_context: Optional[ServicingV2ObjectconfigurationExecutionContextDTO] = Field(default=None, description="The context of the API request, such as the tenant code and project ID.", alias="executionContext") + concept: Optional[ServicingV2ObjectconfigurationConceptDefinitionDTO] = Field(default=None, description="Information about the concept, such as its UUID and concept type.") + __properties: ClassVar[List[str]] = ["executionContext", "concept"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptWithContextDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of execution_context + if self.execution_context: + _dict['executionContext'] = self.execution_context.to_dict() + # override the default output from pydantic by calling `to_dict()` of concept + if self.concept: + _dict['concept'] = self.concept.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationConceptWithContextDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "executionContext": ServicingV2ObjectconfigurationExecutionContextDTO.from_dict(obj["executionContext"]) if obj.get("executionContext") is not None else None, + "concept": ServicingV2ObjectconfigurationConceptDefinitionDTO.from_dict(obj["concept"]) if obj.get("concept") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_execution_context_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_execution_context_dto.py new file mode 100644 index 0000000000..a5f6182763 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_execution_context_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationExecutionContextDTO(BaseModel): + """ + The context of the API request, such as the tenant code and project ID. + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project ID.", alias="projectId") + __properties: ClassVar[List[str]] = ["tenantCode", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationExecutionContextDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationExecutionContextDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_failed_change_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_failed_change_dto.py new file mode 100644 index 0000000000..753cb2f8da --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_failed_change_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_execution_context_dto import ServicingV2ObjectconfigurationExecutionContextDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationFailedChangeDTO(BaseModel): + """ + ServicingV2ObjectconfigurationFailedChangeDTO + """ # noqa: E501 + execution_context: Optional[ServicingV2ObjectconfigurationExecutionContextDTO] = Field(default=None, description="The tenant and, optionally, project that change was attempted on.", alias="executionContext") + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the object that was attempted to be changed.", alias="objectName") + uuid: Optional[StrictStr] = Field(default=None, description="The UUID of the object that was attempted to be changed.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the object that was attempted to be changed.", alias="displayName") + messages: Optional[List[StrictStr]] = Field(default=None, description="The error messages.") + __properties: ClassVar[List[str]] = ["executionContext", "objectName", "uuid", "displayName", "messages"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationFailedChangeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of execution_context + if self.execution_context: + _dict['executionContext'] = self.execution_context.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationFailedChangeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "executionContext": ServicingV2ObjectconfigurationExecutionContextDTO.from_dict(obj["executionContext"]) if obj.get("executionContext") is not None else None, + "objectName": obj.get("objectName"), + "uuid": obj.get("uuid"), + "displayName": obj.get("displayName"), + "messages": obj.get("messages") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_definition_dto.py new file mode 100644 index 0000000000..35f7b62ef6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_definition_dto.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_basic_information_dto import ServicingV2ObjectconfigurationBasicInformationDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_metric_type_details_dto import ServicingV2ObjectconfigurationMetricTypeDetailsDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationMetricDefinitionDTO(BaseModel): + """ + Information about the metric, such as its object name, basic information, and additive type. + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The UUID identifying the metric.") + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the metric.", alias="objectName") + basic_information: Optional[ServicingV2ObjectconfigurationBasicInformationDTO] = Field(default=None, description="Fields that identify and describe the metric, such as its display name, description, and explanation.", alias="basicInformation") + details: Optional[ServicingV2ObjectconfigurationMetricTypeDetailsDTO] = Field(default=None, description="The metric type and its details.") + additive_type: Optional[StrictStr] = Field(default=None, description="How to sum the metric's values. Valid values: - `fullyAdditive`: Sums the metric over any dimension, concept, or time period. - `balance`: Sums the metric over any dimension or concept, but not time period. - `nonAdditive`: Metric values are not additive.", alias="additiveType") + __properties: ClassVar[List[str]] = ["uuid", "objectName", "basicInformation", "details", "additiveType"] + + @field_validator('additive_type') + def additive_type_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['fullyAdditive', 'balance', 'nonAdditive', 'unknown']): + raise ValueError("must be one of enum values ('fullyAdditive', 'balance', 'nonAdditive', 'unknown')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationMetricDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of basic_information + if self.basic_information: + _dict['basicInformation'] = self.basic_information.to_dict() + # override the default output from pydantic by calling `to_dict()` of details + if self.details: + _dict['details'] = self.details.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationMetricDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "objectName": obj.get("objectName"), + "basicInformation": ServicingV2ObjectconfigurationBasicInformationDTO.from_dict(obj["basicInformation"]) if obj.get("basicInformation") is not None else None, + "details": ServicingV2ObjectconfigurationMetricTypeDetailsDTO.from_dict(obj["details"]) if obj.get("details") is not None else None, + "additiveType": obj.get("additiveType") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_type_details_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_type_details_dto.py new file mode 100644 index 0000000000..0793e207b9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_type_details_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_metric_definition_dto import ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationMetricTypeDetailsDTO(BaseModel): + """ + ServicingV2ObjectconfigurationMetricTypeDetailsDTO + """ # noqa: E501 + process_concept: Optional[ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO] = Field(default=None, description="Information about the metric, such as its formula and data type.", alias="processConcept") + __properties: ClassVar[List[str]] = ["processConcept"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationMetricTypeDetailsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of process_concept + if self.process_concept: + _dict['processConcept'] = self.process_concept.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationMetricTypeDetailsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "processConcept": ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO.from_dict(obj["processConcept"]) if obj.get("processConcept") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_object_id_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_object_id_dto.py new file mode 100644 index 0000000000..43a8fc0db5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_object_id_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationObjectIdDTO(BaseModel): + """ + The identifier for the object. + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The UUID identifying the object.") + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the object.", alias="objectName") + __properties: ClassVar[List[str]] = ["uuid", "objectName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationObjectIdDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationObjectIdDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "objectName": obj.get("objectName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_definition_dto.py new file mode 100644 index 0000000000..d0d01695f3 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_definition_dto.py @@ -0,0 +1,128 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_metric_list_dto import ServicingV2ObjectconfigurationProcessConceptMetricListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_outcome_list_dto import ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_property_list_dto import ServicingV2ObjectconfigurationProcessConceptPropertyListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_stage_list_dto import ServicingV2ObjectconfigurationProcessConceptStageListDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_tag_reference_list_dto import ServicingV2ObjectconfigurationTagReferenceListDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptDefinitionDTO(BaseModel): + """ + The process concept's associated objects, such as its analytic object and status dimension. + """ # noqa: E501 + analytic_object_name: Optional[StrictStr] = Field(default=None, description="The object name of the analytic object for the process concept.", alias="analyticObjectName") + status_dimension_object_name: Optional[StrictStr] = Field(default=None, description="The object name of the status dimension for the process concept.", alias="statusDimensionObjectName") + participation_concept_uuid: Optional[StrictStr] = Field(default=None, description="The UUID of the participation concept for the process concept.", alias="participationConceptUuid") + on_hold_concept_uuid: Optional[StrictStr] = Field(default=None, description="The UUID of the on-hold concept for the process concept.", alias="onHoldConceptUuid") + stage_list: Optional[ServicingV2ObjectconfigurationProcessConceptStageListDTO] = Field(default=None, description="The process concept's stages.", alias="stageList") + outcome_list: Optional[ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO] = Field(default=None, description="The process concept's outcomes.", alias="outcomeList") + metric_list: Optional[ServicingV2ObjectconfigurationProcessConceptMetricListDTO] = Field(default=None, description="The process concept's associated metrics.", alias="metricList") + property_list: Optional[ServicingV2ObjectconfigurationProcessConceptPropertyListDTO] = Field(default=None, description="The process concept's associated properties.", alias="propertyList") + tag_list: Optional[ServicingV2ObjectconfigurationTagReferenceListDTO] = Field(default=None, description="The tags assigned to the object.", alias="tagList") + visible_in_analytics: Optional[StrictBool] = Field(default=None, description="If `true`, the object is visible to end users in the solution.", alias="visibleInAnalytics") + include_with_vee: Optional[StrictBool] = Field(default=None, description="If `true`, the object is available in Vee's responses.", alias="includeWithVee") + __properties: ClassVar[List[str]] = ["analyticObjectName", "statusDimensionObjectName", "participationConceptUuid", "onHoldConceptUuid", "stageList", "outcomeList", "metricList", "propertyList", "tagList", "visibleInAnalytics", "includeWithVee"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of stage_list + if self.stage_list: + _dict['stageList'] = self.stage_list.to_dict() + # override the default output from pydantic by calling `to_dict()` of outcome_list + if self.outcome_list: + _dict['outcomeList'] = self.outcome_list.to_dict() + # override the default output from pydantic by calling `to_dict()` of metric_list + if self.metric_list: + _dict['metricList'] = self.metric_list.to_dict() + # override the default output from pydantic by calling `to_dict()` of property_list + if self.property_list: + _dict['propertyList'] = self.property_list.to_dict() + # override the default output from pydantic by calling `to_dict()` of tag_list + if self.tag_list: + _dict['tagList'] = self.tag_list.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analyticObjectName": obj.get("analyticObjectName"), + "statusDimensionObjectName": obj.get("statusDimensionObjectName"), + "participationConceptUuid": obj.get("participationConceptUuid"), + "onHoldConceptUuid": obj.get("onHoldConceptUuid"), + "stageList": ServicingV2ObjectconfigurationProcessConceptStageListDTO.from_dict(obj["stageList"]) if obj.get("stageList") is not None else None, + "outcomeList": ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO.from_dict(obj["outcomeList"]) if obj.get("outcomeList") is not None else None, + "metricList": ServicingV2ObjectconfigurationProcessConceptMetricListDTO.from_dict(obj["metricList"]) if obj.get("metricList") is not None else None, + "propertyList": ServicingV2ObjectconfigurationProcessConceptPropertyListDTO.from_dict(obj["propertyList"]) if obj.get("propertyList") is not None else None, + "tagList": ServicingV2ObjectconfigurationTagReferenceListDTO.from_dict(obj["tagList"]) if obj.get("tagList") is not None else None, + "visibleInAnalytics": obj.get("visibleInAnalytics"), + "includeWithVee": obj.get("includeWithVee") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_dto.py new file mode 100644 index 0000000000..3828017474 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptMemberDTO(BaseModel): + """ + Each member mapped to a stage or outcome in the process concept. + """ # noqa: E501 + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the mapped member.", alias="displayName") + name_path: Optional[List[StrictStr]] = Field(default=None, description="The name path of the mapped member.", alias="namePath") + __properties: ClassVar[List[str]] = ["displayName", "namePath"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptMemberDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptMemberDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "displayName": obj.get("displayName"), + "namePath": obj.get("namePath") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_list_dto.py new file mode 100644 index 0000000000..c6a0a221c9 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_list_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_member_dto import ServicingV2ObjectconfigurationProcessConceptMemberDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptMemberListDTO(BaseModel): + """ + The members mapped to a stage or outcome in the process concept. + """ # noqa: E501 + members: Optional[List[ServicingV2ObjectconfigurationProcessConceptMemberDTO]] = Field(default=None, description="Each member mapped to a stage or outcome in the process concept.") + __properties: ClassVar[List[str]] = ["members"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptMemberListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in members (list) + _items = [] + if self.members: + for _item_members in self.members: + if _item_members: + _items.append(_item_members.to_dict()) + _dict['members'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptMemberListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "members": [ServicingV2ObjectconfigurationProcessConceptMemberDTO.from_dict(_item) for _item in obj["members"]] if obj.get("members") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_definition_dto.py new file mode 100644 index 0000000000..15ebb22ed7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_definition_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO(BaseModel): + """ + Information about the metric, such as its formula and data type. + """ # noqa: E501 + formula: Optional[StrictStr] = Field(default=None, description="The metric's formula written in Visier Formula Language (VFL).") + data_type: Optional[StrictStr] = Field(default=None, description="The metric's data type. Valid values: `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`, `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`, `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`.", alias="dataType") + visible_in_analytics: Optional[StrictBool] = Field(default=None, description="If `true`, the object is visible to end users in the solution. Default is `true`.", alias="visibleInAnalytics") + __properties: ClassVar[List[str]] = ["formula", "dataType", "visibleInAnalytics"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptMetricDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "formula": obj.get("formula"), + "dataType": obj.get("dataType"), + "visibleInAnalytics": obj.get("visibleInAnalytics") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_list_dto.py new file mode 100644 index 0000000000..f0756aec19 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_list_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_metric_definition_dto import ServicingV2ObjectconfigurationMetricDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptMetricListDTO(BaseModel): + """ + The process concept's associated metrics. + """ # noqa: E501 + metrics: Optional[List[ServicingV2ObjectconfigurationMetricDefinitionDTO]] = Field(default=None, description="Each metric in the process concept.") + __properties: ClassVar[List[str]] = ["metrics"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptMetricListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in metrics (list) + _items = [] + if self.metrics: + for _item_metrics in self.metrics: + if _item_metrics: + _items.append(_item_metrics.to_dict()) + _dict['metrics'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptMetricListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "metrics": [ServicingV2ObjectconfigurationMetricDefinitionDTO.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_dto.py new file mode 100644 index 0000000000..45f3302df2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_dto.py @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_basic_information_dto import ServicingV2ObjectconfigurationBasicInformationDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_member_list_dto import ServicingV2ObjectconfigurationProcessConceptMemberListDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptOutcomeDTO(BaseModel): + """ + Information about a process concept outcome. + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The UUID identifying the process concept outcome.") + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the process concept outcome.", alias="objectName") + basic_information: Optional[ServicingV2ObjectconfigurationBasicInformationDTO] = Field(default=None, description="Fields that identify and describe the concept outcome, such as its display name, description, and explanation.", alias="basicInformation") + outcome_semantic: Optional[StrictStr] = Field(default=None, description="The end result of the process. Valid values: - `Success`: The outcome is considered successful; for example, Hired. This is the default. - `Fail`: The outcome is considered a failure; for example, Rejected.", alias="outcomeSemantic") + mapped_member_list: Optional[ServicingV2ObjectconfigurationProcessConceptMemberListDTO] = Field(default=None, description="Each member mapped to the process concept outcome.", alias="mappedMemberList") + __properties: ClassVar[List[str]] = ["uuid", "objectName", "basicInformation", "outcomeSemantic", "mappedMemberList"] + + @field_validator('outcome_semantic') + def outcome_semantic_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['Success', 'Fail']): + raise ValueError("must be one of enum values ('Success', 'Fail')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptOutcomeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of basic_information + if self.basic_information: + _dict['basicInformation'] = self.basic_information.to_dict() + # override the default output from pydantic by calling `to_dict()` of mapped_member_list + if self.mapped_member_list: + _dict['mappedMemberList'] = self.mapped_member_list.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptOutcomeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "objectName": obj.get("objectName"), + "basicInformation": ServicingV2ObjectconfigurationBasicInformationDTO.from_dict(obj["basicInformation"]) if obj.get("basicInformation") is not None else None, + "outcomeSemantic": obj.get("outcomeSemantic"), + "mappedMemberList": ServicingV2ObjectconfigurationProcessConceptMemberListDTO.from_dict(obj["mappedMemberList"]) if obj.get("mappedMemberList") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_list_dto.py new file mode 100644 index 0000000000..bf17f64f15 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_list_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_outcome_dto import ServicingV2ObjectconfigurationProcessConceptOutcomeDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO(BaseModel): + """ + The process concept's outcomes. + """ # noqa: E501 + outcomes: Optional[List[ServicingV2ObjectconfigurationProcessConceptOutcomeDTO]] = Field(default=None, description="Each outcome in the process concept.") + __properties: ClassVar[List[str]] = ["outcomes"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in outcomes (list) + _items = [] + if self.outcomes: + for _item_outcomes in self.outcomes: + if _item_outcomes: + _items.append(_item_outcomes.to_dict()) + _dict['outcomes'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptOutcomeListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "outcomes": [ServicingV2ObjectconfigurationProcessConceptOutcomeDTO.from_dict(_item) for _item in obj["outcomes"]] if obj.get("outcomes") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_list_dto.py new file mode 100644 index 0000000000..18333516b2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_list_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_property_definition_dto import ServicingV2ObjectconfigurationPropertyDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptPropertyListDTO(BaseModel): + """ + The process concept's associated properties. + """ # noqa: E501 + properties: Optional[List[ServicingV2ObjectconfigurationPropertyDefinitionDTO]] = Field(default=None, description="Each property in the process concept.") + __properties: ClassVar[List[str]] = ["properties"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptPropertyListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in properties (list) + _items = [] + if self.properties: + for _item_properties in self.properties: + if _item_properties: + _items.append(_item_properties.to_dict()) + _dict['properties'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptPropertyListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "properties": [ServicingV2ObjectconfigurationPropertyDefinitionDTO.from_dict(_item) for _item in obj["properties"]] if obj.get("properties") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_type_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_type_dto.py new file mode 100644 index 0000000000..90cbe5c7a1 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_type_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO(BaseModel): + """ + A process concept property that takes a value that comes directly from the data and creates a new value through a formula. + """ # noqa: E501 + data_type: Optional[StrictStr] = Field(default=None, description="The property's data type. Valid values: `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`, `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`, `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`.", alias="dataType") + primitive_type: Optional[StrictStr] = Field(default=None, description="The primitive data type, such as String, Integer, or Boolean.", alias="primitiveType") + formula: Optional[StrictStr] = Field(default=None, description="The property's formula written in Visier Formula Language (VFL).") + __properties: ClassVar[List[str]] = ["dataType", "primitiveType", "formula"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataType": obj.get("dataType"), + "primitiveType": obj.get("primitiveType"), + "formula": obj.get("formula") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_dto.py new file mode 100644 index 0000000000..1c2e676313 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_basic_information_dto import ServicingV2ObjectconfigurationBasicInformationDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_member_list_dto import ServicingV2ObjectconfigurationProcessConceptMemberListDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptStageDTO(BaseModel): + """ + Information about a process concept stage. + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The UUID identifying the process concept stage.") + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the process concept stage.", alias="objectName") + basic_information: Optional[ServicingV2ObjectconfigurationBasicInformationDTO] = Field(default=None, description="Fields that identify and describe the concept stage, such as its display name, description, and explanation.", alias="basicInformation") + mapped_member_list: Optional[ServicingV2ObjectconfigurationProcessConceptMemberListDTO] = Field(default=None, description="The members mapped to the process concept stage.", alias="mappedMemberList") + __properties: ClassVar[List[str]] = ["uuid", "objectName", "basicInformation", "mappedMemberList"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptStageDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of basic_information + if self.basic_information: + _dict['basicInformation'] = self.basic_information.to_dict() + # override the default output from pydantic by calling `to_dict()` of mapped_member_list + if self.mapped_member_list: + _dict['mappedMemberList'] = self.mapped_member_list.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptStageDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "objectName": obj.get("objectName"), + "basicInformation": ServicingV2ObjectconfigurationBasicInformationDTO.from_dict(obj["basicInformation"]) if obj.get("basicInformation") is not None else None, + "mappedMemberList": ServicingV2ObjectconfigurationProcessConceptMemberListDTO.from_dict(obj["mappedMemberList"]) if obj.get("mappedMemberList") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_list_dto.py new file mode 100644 index 0000000000..91cb7612be --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_list_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_stage_dto import ServicingV2ObjectconfigurationProcessConceptStageDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationProcessConceptStageListDTO(BaseModel): + """ + The process concept's stages. + """ # noqa: E501 + stages: Optional[List[ServicingV2ObjectconfigurationProcessConceptStageDTO]] = Field(default=None, description="Each stage in the process concept.") + __properties: ClassVar[List[str]] = ["stages"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptStageListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in stages (list) + _items = [] + if self.stages: + for _item_stages in self.stages: + if _item_stages: + _items.append(_item_stages.to_dict()) + _dict['stages'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationProcessConceptStageListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "stages": [ServicingV2ObjectconfigurationProcessConceptStageDTO.from_dict(_item) for _item in obj["stages"]] if obj.get("stages") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_property_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_property_definition_dto.py new file mode 100644 index 0000000000..a7cd81da32 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_property_definition_dto.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_basic_information_dto import ServicingV2ObjectconfigurationBasicInformationDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_property_type_details_dto import ServicingV2ObjectconfigurationPropertyTypeDetailsDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationPropertyDefinitionDTO(BaseModel): + """ + ServicingV2ObjectconfigurationPropertyDefinitionDTO + """ # noqa: E501 + uuid: Optional[StrictStr] = Field(default=None, description="The UUID identifying the property.") + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the property.", alias="objectName") + basic_information: Optional[ServicingV2ObjectconfigurationBasicInformationDTO] = Field(default=None, description="Fields that identify and describe the property, such as its display name, description, and explanation.", alias="basicInformation") + details: Optional[ServicingV2ObjectconfigurationPropertyTypeDetailsDTO] = Field(default=None, description="The property type and its details.") + __properties: ClassVar[List[str]] = ["uuid", "objectName", "basicInformation", "details"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationPropertyDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of basic_information + if self.basic_information: + _dict['basicInformation'] = self.basic_information.to_dict() + # override the default output from pydantic by calling `to_dict()` of details + if self.details: + _dict['details'] = self.details.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationPropertyDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "uuid": obj.get("uuid"), + "objectName": obj.get("objectName"), + "basicInformation": ServicingV2ObjectconfigurationBasicInformationDTO.from_dict(obj["basicInformation"]) if obj.get("basicInformation") is not None else None, + "details": ServicingV2ObjectconfigurationPropertyTypeDetailsDTO.from_dict(obj["details"]) if obj.get("details") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_property_type_details_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_property_type_details_dto.py new file mode 100644 index 0000000000..b98b180282 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_property_type_details_dto.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_calculated_property_type_dto import ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_process_concept_property_type_dto import ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO +from visier_platform_sdk.models.servicing_v2_objectconfiguration_simple_property_type_dto import ServicingV2ObjectconfigurationSimplePropertyTypeDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationPropertyTypeDetailsDTO(BaseModel): + """ + The property type. + """ # noqa: E501 + simple: Optional[ServicingV2ObjectconfigurationSimplePropertyTypeDTO] = Field(default=None, description="The simple property type, which provides a single value directly from the data.") + calculated: Optional[ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO] = Field(default=None, description="The calculated property type, which derives its value using a formula.") + process_concept: Optional[ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO] = Field(default=None, description="The process concept property type, which describes the relationship between subject member properties and a subject member in the process pipeline.", alias="processConcept") + __properties: ClassVar[List[str]] = ["simple", "calculated", "processConcept"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationPropertyTypeDetailsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of simple + if self.simple: + _dict['simple'] = self.simple.to_dict() + # override the default output from pydantic by calling `to_dict()` of calculated + if self.calculated: + _dict['calculated'] = self.calculated.to_dict() + # override the default output from pydantic by calling `to_dict()` of process_concept + if self.process_concept: + _dict['processConcept'] = self.process_concept.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationPropertyTypeDetailsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "simple": ServicingV2ObjectconfigurationSimplePropertyTypeDTO.from_dict(obj["simple"]) if obj.get("simple") is not None else None, + "calculated": ServicingV2ObjectconfigurationCalculatedPropertyTypeDTO.from_dict(obj["calculated"]) if obj.get("calculated") is not None else None, + "processConcept": ServicingV2ObjectconfigurationProcessConceptPropertyTypeDTO.from_dict(obj["processConcept"]) if obj.get("processConcept") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_simple_property_type_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_simple_property_type_dto.py new file mode 100644 index 0000000000..9bc8709b56 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_simple_property_type_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationSimplePropertyTypeDTO(BaseModel): + """ + A simple property that provides single-level detail to an analytic object and contains one value at a time. + """ # noqa: E501 + data_type: Optional[StrictStr] = Field(default=None, description="The property's data type. Valid values: `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`, `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`, `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`.", alias="dataType") + primitive_type: Optional[StrictStr] = Field(default=None, description="The primitive data type, such as String, Integer, or Boolean.", alias="primitiveType") + __properties: ClassVar[List[str]] = ["dataType", "primitiveType"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationSimplePropertyTypeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationSimplePropertyTypeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dataType": obj.get("dataType"), + "primitiveType": obj.get("primitiveType") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_successful_change_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_successful_change_dto.py new file mode 100644 index 0000000000..11da588931 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_successful_change_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_execution_context_dto import ServicingV2ObjectconfigurationExecutionContextDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationSuccessfulChangeDTO(BaseModel): + """ + ServicingV2ObjectconfigurationSuccessfulChangeDTO + """ # noqa: E501 + execution_context: Optional[ServicingV2ObjectconfigurationExecutionContextDTO] = Field(default=None, description="The tenant and, optionally, project that change was made on.", alias="executionContext") + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the object that was changed.", alias="objectName") + uuid: Optional[StrictStr] = Field(default=None, description="The UUID of the object that was changed.") + display_name: Optional[StrictStr] = Field(default=None, description="The display name of the object that was changed.", alias="displayName") + __properties: ClassVar[List[str]] = ["executionContext", "objectName", "uuid", "displayName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationSuccessfulChangeDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of execution_context + if self.execution_context: + _dict['executionContext'] = self.execution_context.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationSuccessfulChangeDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "executionContext": ServicingV2ObjectconfigurationExecutionContextDTO.from_dict(obj["executionContext"]) if obj.get("executionContext") is not None else None, + "objectName": obj.get("objectName"), + "uuid": obj.get("uuid"), + "displayName": obj.get("displayName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_synonym_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_synonym_list_dto.py new file mode 100644 index 0000000000..2b8ef4fca5 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_synonym_list_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationSynonymListDTO(BaseModel): + """ + The object's synonyms. + """ # noqa: E501 + synonyms: Optional[List[StrictStr]] = Field(default=None, description="Alternative words or phrases for the object.") + __properties: ClassVar[List[str]] = ["synonyms"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationSynonymListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationSynonymListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "synonyms": obj.get("synonyms") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_dto.py new file mode 100644 index 0000000000..dce5c9d7dc --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationTagReferenceDTO(BaseModel): + """ + A reference to a tag. + """ # noqa: E501 + object_name: Optional[StrictStr] = Field(default=None, description="The object name of the tag.", alias="objectName") + __properties: ClassVar[List[str]] = ["objectName"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationTagReferenceDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationTagReferenceDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objectName": obj.get("objectName") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_list_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_list_dto.py new file mode 100644 index 0000000000..ae2b94ec79 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_list_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_v2_objectconfiguration_tag_reference_dto import ServicingV2ObjectconfigurationTagReferenceDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingV2ObjectconfigurationTagReferenceListDTO(BaseModel): + """ + The tags assigned to the object. + """ # noqa: E501 + tags: Optional[List[ServicingV2ObjectconfigurationTagReferenceDTO]] = Field(default=None, description="A list of tags assigned to the object.") + __properties: ClassVar[List[str]] = ["tags"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationTagReferenceListDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tags (list) + _items = [] + if self.tags: + for _item_tags in self.tags: + if _item_tags: + _items.append(_item_tags.to_dict()) + _dict['tags'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingV2ObjectconfigurationTagReferenceListDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tags": [ServicingV2ObjectconfigurationTagReferenceDTO.from_dict(_item) for _item in obj["tags"]] if obj.get("tags") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_definition_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_definition_dto.py new file mode 100644 index 0000000000..a3c1e42421 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_definition_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_user_group_assignment_dto import ServicingUserGroupAssignmentDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingVeeQuestionChangeDefinitionDTO(BaseModel): + """ + ServicingVeeQuestionChangeDefinitionDTO + """ # noqa: E501 + question: Optional[StrictStr] = Field(default=None, description="A question in plain language to display in Vee.") + question_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the sample question. Omit if creating a new sample question.", alias="questionId") + visible_in_vee: Optional[StrictBool] = Field(default=None, description="If `true`, the question is visible in Vee. Default is `true`.", alias="visibleInVee") + category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the question category.", alias="categoryId") + user_group_assignment: Optional[ServicingUserGroupAssignmentDTO] = Field(default=None, description="The user group IDs assigned to the sample question.", alias="userGroupAssignment") + __properties: ClassVar[List[str]] = ["question", "questionId", "visibleInVee", "categoryId", "userGroupAssignment"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionChangeDefinitionDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user_group_assignment + if self.user_group_assignment: + _dict['userGroupAssignment'] = self.user_group_assignment.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionChangeDefinitionDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "question": obj.get("question"), + "questionId": obj.get("questionId"), + "visibleInVee": obj.get("visibleInVee"), + "categoryId": obj.get("categoryId"), + "userGroupAssignment": ServicingUserGroupAssignmentDTO.from_dict(obj["userGroupAssignment"]) if obj.get("userGroupAssignment") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_definitions_by_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_definitions_by_tenant_dto.py new file mode 100644 index 0000000000..3952643ea6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_definitions_by_tenant_dto.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_vee_question_change_definition_dto import ServicingVeeQuestionChangeDefinitionDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingVeeQuestionChangeDefinitionsByTenantDTO(BaseModel): + """ + ServicingVeeQuestionChangeDefinitionsByTenantDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the tenant in which to update sample questions.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="To make changes in a project, specify a project ID.", alias="projectId") + questions: Optional[List[ServicingVeeQuestionChangeDefinitionDTO]] = Field(default=None, description="The list of sample questions to update.") + __properties: ClassVar[List[str]] = ["tenantCode", "projectId", "questions"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionChangeDefinitionsByTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in questions (list) + _items = [] + if self.questions: + for _item_questions in self.questions: + if _item_questions: + _items.append(_item_questions.to_dict()) + _dict['questions'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionChangeDefinitionsByTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId"), + "questions": [ServicingVeeQuestionChangeDefinitionDTO.from_dict(_item) for _item in obj["questions"]] if obj.get("questions") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_failure_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_failure_dto.py new file mode 100644 index 0000000000..4c44542aa7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_failure_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_user_group_assignment_dto import ServicingUserGroupAssignmentDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingVeeQuestionChangeFailureDTO(BaseModel): + """ + ServicingVeeQuestionChangeFailureDTO + """ # noqa: E501 + question: Optional[StrictStr] = Field(default=None, description="The question in plain language that was not successfully changed.") + question_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the sample question that was not successfully changed.", alias="questionId") + category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the category of the sample question that was not successfully changed.", alias="categoryId") + user_group_assignment: Optional[ServicingUserGroupAssignmentDTO] = Field(default=None, description="The user group IDs that were not successfully assigned to the sample question.", alias="userGroupAssignment") + message: Optional[StrictStr] = Field(default=None, description="An error message describing the cause of the failure.") + rci: Optional[StrictStr] = Field(default=None, description="The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant that the object was not successfully changed in.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project that the object was not successfully changed in.", alias="projectId") + __properties: ClassVar[List[str]] = ["question", "questionId", "categoryId", "userGroupAssignment", "message", "rci", "tenantCode", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionChangeFailureDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user_group_assignment + if self.user_group_assignment: + _dict['userGroupAssignment'] = self.user_group_assignment.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionChangeFailureDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "question": obj.get("question"), + "questionId": obj.get("questionId"), + "categoryId": obj.get("categoryId"), + "userGroupAssignment": ServicingUserGroupAssignmentDTO.from_dict(obj["userGroupAssignment"]) if obj.get("userGroupAssignment") is not None else None, + "message": obj.get("message"), + "rci": obj.get("rci"), + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_success_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_success_dto.py new file mode 100644 index 0000000000..76616cef25 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_change_success_dto.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_user_group_assignment_dto import ServicingUserGroupAssignmentDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingVeeQuestionChangeSuccessDTO(BaseModel): + """ + ServicingVeeQuestionChangeSuccessDTO + """ # noqa: E501 + question: Optional[StrictStr] = Field(default=None, description="The sample question in plain language that was successfully changed.") + question_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the sample question that was successfully changed.", alias="questionId") + visible_in_vee: Optional[StrictBool] = Field(default=None, description="If `true`, the question is visible in Vee.", alias="visibleInVee") + category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the category of the question that was successfully changed.", alias="categoryId") + user_group_assignment: Optional[ServicingUserGroupAssignmentDTO] = Field(default=None, description="The user group IDs that were successfully assigned to the sample question.", alias="userGroupAssignment") + tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant that the sample question was changed in.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project that the sample question was changed in.", alias="projectId") + __properties: ClassVar[List[str]] = ["question", "questionId", "visibleInVee", "categoryId", "userGroupAssignment", "tenantCode", "projectId"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionChangeSuccessDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of user_group_assignment + if self.user_group_assignment: + _dict['userGroupAssignment'] = self.user_group_assignment.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionChangeSuccessDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "question": obj.get("question"), + "questionId": obj.get("questionId"), + "visibleInVee": obj.get("visibleInVee"), + "categoryId": obj.get("categoryId"), + "userGroupAssignment": ServicingUserGroupAssignmentDTO.from_dict(obj["userGroupAssignment"]) if obj.get("userGroupAssignment") is not None else None, + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_delete_definitions_by_tenant_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_delete_definitions_by_tenant_dto.py new file mode 100644 index 0000000000..796a1dc5df --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_question_delete_definitions_by_tenant_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ServicingVeeQuestionDeleteDefinitionsByTenantDTO(BaseModel): + """ + ServicingVeeQuestionDeleteDefinitionsByTenantDTO + """ # noqa: E501 + tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant to delete sample questions from. Default is the current tenant.", alias="tenantCode") + project_id: Optional[StrictStr] = Field(default=None, description="The project in which to delete sample questions. If omitted and the ProjectID request header is not defined, the change is published to production immediately.", alias="projectId") + question_ids: Optional[List[StrictStr]] = Field(default=None, description="The IDs of the sample questions to delete for a specific tenant.", alias="questionIds") + __properties: ClassVar[List[str]] = ["tenantCode", "projectId", "questionIds"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionDeleteDefinitionsByTenantDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionDeleteDefinitionsByTenantDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "tenantCode": obj.get("tenantCode"), + "projectId": obj.get("projectId"), + "questionIds": obj.get("questionIds") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_questions_bulk_change_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_questions_bulk_change_response_dto.py new file mode 100644 index 0000000000..219ac800f2 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_questions_bulk_change_response_dto.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_vee_question_change_failure_dto import ServicingVeeQuestionChangeFailureDTO +from visier_platform_sdk.models.servicing_vee_question_change_success_dto import ServicingVeeQuestionChangeSuccessDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingVeeQuestionsBulkChangeResponseDTO(BaseModel): + """ + ServicingVeeQuestionsBulkChangeResponseDTO + """ # noqa: E501 + successes: Optional[List[ServicingVeeQuestionChangeSuccessDTO]] = Field(default=None, description="The sample questions that were successfully changed.") + failures: Optional[List[ServicingVeeQuestionChangeFailureDTO]] = Field(default=None, description="The sample questions that were not successfully changed.") + __properties: ClassVar[List[str]] = ["successes", "failures"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionsBulkChangeResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in successes (list) + _items = [] + if self.successes: + for _item_successes in self.successes: + if _item_successes: + _items.append(_item_successes.to_dict()) + _dict['successes'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in failures (list) + _items = [] + if self.failures: + for _item_failures in self.failures: + if _item_failures: + _items.append(_item_failures.to_dict()) + _dict['failures'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionsBulkChangeResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "successes": [ServicingVeeQuestionChangeSuccessDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None, + "failures": [ServicingVeeQuestionChangeFailureDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_questions_change_definitions_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_questions_change_definitions_dto.py new file mode 100644 index 0000000000..e962082f06 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_questions_change_definitions_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_vee_question_change_definitions_by_tenant_dto import ServicingVeeQuestionChangeDefinitionsByTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingVeeQuestionsChangeDefinitionsDTO(BaseModel): + """ + ServicingVeeQuestionsChangeDefinitionsDTO + """ # noqa: E501 + questions_by_tenant: Optional[List[ServicingVeeQuestionChangeDefinitionsByTenantDTO]] = Field(default=None, description="The Vee sample question updates to make in each tenant.", alias="questionsByTenant") + __properties: ClassVar[List[str]] = ["questionsByTenant"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionsChangeDefinitionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in questions_by_tenant (list) + _items = [] + if self.questions_by_tenant: + for _item_questions_by_tenant in self.questions_by_tenant: + if _item_questions_by_tenant: + _items.append(_item_questions_by_tenant.to_dict()) + _dict['questionsByTenant'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionsChangeDefinitionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "questionsByTenant": [ServicingVeeQuestionChangeDefinitionsByTenantDTO.from_dict(_item) for _item in obj["questionsByTenant"]] if obj.get("questionsByTenant") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_questions_delete_definitions_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_questions_delete_definitions_dto.py new file mode 100644 index 0000000000..3acd50ae27 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/servicing_vee_questions_delete_definitions_dto.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.servicing_vee_question_delete_definitions_by_tenant_dto import ServicingVeeQuestionDeleteDefinitionsByTenantDTO +from typing import Optional, Set +from typing_extensions import Self + +class ServicingVeeQuestionsDeleteDefinitionsDTO(BaseModel): + """ + ServicingVeeQuestionsDeleteDefinitionsDTO + """ # noqa: E501 + questions_by_tenant: Optional[List[ServicingVeeQuestionDeleteDefinitionsByTenantDTO]] = Field(default=None, description="The sample questions to delete for each tenant.", alias="questionsByTenant") + __properties: ClassVar[List[str]] = ["questionsByTenant"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionsDeleteDefinitionsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in questions_by_tenant (list) + _items = [] + if self.questions_by_tenant: + for _item_questions_by_tenant in self.questions_by_tenant: + if _item_questions_by_tenant: + _items.append(_item_questions_by_tenant.to_dict()) + _dict['questionsByTenant'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServicingVeeQuestionsDeleteDefinitionsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "questionsByTenant": [ServicingVeeQuestionDeleteDefinitionsByTenantDTO.from_dict(_item) for _item in obj["questionsByTenant"]] if obj.get("questionsByTenant") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/skill.py b/src/visier_platform_sdk/visier_platform_sdk/models/skill.py new file mode 100644 index 0000000000..1104cc7c7c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/skill.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class Skill(BaseModel): + """ + The details describing a skill. + """ # noqa: E501 + id: StrictStr = Field(description="The unique ID of the skill. ") + name: StrictStr = Field(description="The localized display name of the skill. ") + description: StrictStr = Field(description="The localized description of the skill. ") + skill_group_id: StrictStr = Field(description="ID of the skill group that this skill belongs to. ", alias="skillGroupId") + skill_category_id: StrictStr = Field(description="ID of the skill category that this skill belongs to. ", alias="skillCategoryId") + is_knowledge: StrictBool = Field(description="Indicates whether the skill is a knowledge skill. ", alias="isKnowledge") + skill_type: StrictStr = Field(description="The type of skill. Valid values are `Soft`, `Hard`, and `Unknown`. ", alias="skillType") + alternative_titles: List[StrictStr] = Field(description="List of alternative localized names for this skill. ", alias="alternativeTitles") + remote_index: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The Remote Index represents how readily a skill can be done through remote work. The index ranges from 0 to 100, where a value of 100 means the skill can be done entirely remotely. This field will be omitted if remotability is not applicable to the skill. ", alias="remoteIndex") + automation_index: Optional[StrictInt] = Field(default=None, description="The Automation Index represents how readily a skill can be automated. The index ranges from 0 to 100, where a value of 100 means the skill is completely automatable. This field will be omitted if automation is not applicable to the skill. ", alias="automationIndex") + __properties: ClassVar[List[str]] = ["id", "name", "description", "skillGroupId", "skillCategoryId", "isKnowledge", "skillType", "alternativeTitles", "remoteIndex", "automationIndex"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Skill from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Skill from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description"), + "skillGroupId": obj.get("skillGroupId"), + "skillCategoryId": obj.get("skillCategoryId"), + "isKnowledge": obj.get("isKnowledge"), + "skillType": obj.get("skillType"), + "alternativeTitles": obj.get("alternativeTitles"), + "remoteIndex": obj.get("remoteIndex"), + "automationIndex": obj.get("automationIndex") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/skill_category.py b/src/visier_platform_sdk/visier_platform_sdk/models/skill_category.py new file mode 100644 index 0000000000..29414fbef7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/skill_category.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from visier_platform_sdk.models.skill_group import SkillGroup +from typing import Optional, Set +from typing_extensions import Self + +class SkillCategory(BaseModel): + """ + Details describing a skill category. + """ # noqa: E501 + id: StrictStr = Field(description="The unique ID of the skill category. ") + name: StrictStr = Field(description="The localized display name of the skill category. ") + description: StrictStr = Field(description="The localized description of the skill category. ") + skill_groups: List[SkillGroup] = Field(description="List of skill groups under this skill category. ", alias="skillGroups") + __properties: ClassVar[List[str]] = ["id", "name", "description", "skillGroups"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SkillCategory from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in skill_groups (list) + _items = [] + if self.skill_groups: + for _item_skill_groups in self.skill_groups: + if _item_skill_groups: + _items.append(_item_skill_groups.to_dict()) + _dict['skillGroups'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SkillCategory from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description"), + "skillGroups": [SkillGroup.from_dict(_item) for _item in obj["skillGroups"]] if obj.get("skillGroups") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/skill_category_entry.py b/src/visier_platform_sdk/visier_platform_sdk/models/skill_category_entry.py new file mode 100644 index 0000000000..8cfaf6d09c --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/skill_category_entry.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SkillCategoryEntry(BaseModel): + """ + SkillCategoryEntry + """ # noqa: E501 + id: StrictStr = Field(description="The unique ID of the skill category. ") + name: StrictStr = Field(description="The localized display name of the skill category. ") + description: StrictStr = Field(description="The localized description of the skill category. ") + __properties: ClassVar[List[str]] = ["id", "name", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SkillCategoryEntry from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SkillCategoryEntry from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/skill_entry.py b/src/visier_platform_sdk/visier_platform_sdk/models/skill_entry.py new file mode 100644 index 0000000000..c86062a74f --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/skill_entry.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SkillEntry(BaseModel): + """ + SkillEntry + """ # noqa: E501 + id: StrictStr = Field(description="The unique ID of the skill. ") + name: StrictStr = Field(description="The localized display name of the skill. ") + description: StrictStr = Field(description="The localized description of the skill. ") + __properties: ClassVar[List[str]] = ["id", "name", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SkillEntry from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SkillEntry from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/skill_extraction_input.py b/src/visier_platform_sdk/visier_platform_sdk/models/skill_extraction_input.py new file mode 100644 index 0000000000..5f7d1a2d0e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/skill_extraction_input.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SkillExtractionInput(BaseModel): + """ + The text to extract skills from, such as a job description or course outline. + """ # noqa: E501 + content: Annotated[str, Field(min_length=4, strict=True, max_length=7500)] = Field(description="The body of text to extract skills from. The maximum length is 7500 characters. The minimum length is 4 characters. ") + language_code: Optional[StrictStr] = Field(default=None, description="Identifies the language of the input text. Format: **ISO 639-1** language code. For a list of supported languages, see \"Supported Languages\" in the Skills Intelligence Engine API documentation. If no value is specified, the response language is used. ", alias="languageCode") + limit: Optional[Annotated[int, Field(le=50, strict=True, ge=1)]] = Field(default=None, description="The limit on the number of skills extracted from the text. The minimum is 1 and the maximum is 50 skills. If no value is specified, the default limit of 10 skills is used. ") + __properties: ClassVar[List[str]] = ["content", "languageCode", "limit"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SkillExtractionInput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SkillExtractionInput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "content": obj.get("content"), + "languageCode": obj.get("languageCode"), + "limit": obj.get("limit") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/skill_group.py b/src/visier_platform_sdk/visier_platform_sdk/models/skill_group.py new file mode 100644 index 0000000000..1f198bcc33 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/skill_group.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from visier_platform_sdk.models.skill import Skill +from typing import Optional, Set +from typing_extensions import Self + +class SkillGroup(BaseModel): + """ + Details describing a skill group. + """ # noqa: E501 + id: StrictStr = Field(description="The unique ID of the skill group. ") + name: StrictStr = Field(description="The localized display name of the skill group. ") + description: StrictStr = Field(description="The localized description of the skill group. ") + skill_category_id: StrictStr = Field(description="ID of the parent skill category. ", alias="skillCategoryId") + skills: List[Skill] = Field(description="List of skills under this skill group. ") + __properties: ClassVar[List[str]] = ["id", "name", "description", "skillCategoryId", "skills"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SkillGroup from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in skills (list) + _items = [] + if self.skills: + for _item_skills in self.skills: + if _item_skills: + _items.append(_item_skills.to_dict()) + _dict['skills'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SkillGroup from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description"), + "skillCategoryId": obj.get("skillCategoryId"), + "skills": [Skill.from_dict(_item) for _item in obj["skills"]] if obj.get("skills") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/skill_group_entry.py b/src/visier_platform_sdk/visier_platform_sdk/models/skill_group_entry.py new file mode 100644 index 0000000000..0722d7e2c6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/skill_group_entry.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class SkillGroupEntry(BaseModel): + """ + SkillGroupEntry + """ # noqa: E501 + id: StrictStr = Field(description="The unique ID of the skill group. ") + name: StrictStr = Field(description="The localized display name of the skill group. ") + description: StrictStr = Field(description="The localized description of the skill group. ") + __properties: ClassVar[List[str]] = ["id", "name", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SkillGroupEntry from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SkillGroupEntry from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "description": obj.get("description") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/skill_match_input.py b/src/visier_platform_sdk/visier_platform_sdk/models/skill_match_input.py new file mode 100644 index 0000000000..8cff2b498e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/skill_match_input.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class SkillMatchInput(BaseModel): + """ + The skill set and the group of skill sets (targets) to be matched. + """ # noqa: E501 + skill_set: Optional[Annotated[List[Annotated[List[Any], Field(min_length=2, max_length=2)]], Field(min_length=1)]] = Field(default=None, description="The skills that make up the skill set that will be matched against a group of skill sets (targets). ", alias="skillSet") + target_skill_sets: Optional[Annotated[List[Annotated[List[Annotated[List[Any], Field(min_length=2, max_length=2)]], Field(min_length=1)]], Field(min_length=1)]] = Field(default=None, description="A comma-separated list of strings that represent the group of skill sets (targets). ", alias="targetSkillSets") + __properties: ClassVar[List[str]] = ["skillSet", "targetSkillSets"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SkillMatchInput from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SkillMatchInput from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "skillSet": obj.get("skillSet"), + "targetSkillSets": obj.get("targetSkillSets") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/source_import_result_summary_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/source_import_result_summary_dto.py new file mode 100644 index 0000000000..7f24a36650 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/source_import_result_summary_dto.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SourceImportResultSummaryDTO(BaseModel): + """ + SourceImportResultSummaryDTO + """ # noqa: E501 + created: Optional[StrictInt] = Field(default=None, description="The number of imported sources that were newly created in the target tenant.") + updated: Optional[StrictInt] = Field(default=None, description="The number of imported sources that already existed and were updated in the target tenant.") + ignored: Optional[StrictInt] = Field(default=None, description="The number of imported sources that already existed and were unchanged in the target tenant.") + deleted: Optional[StrictInt] = Field(default=None, description="The number of imported sources that existed in the target tenant prior to the import and were deleted during the import.") + __properties: ClassVar[List[str]] = ["created", "updated", "ignored", "deleted"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SourceImportResultSummaryDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SourceImportResultSummaryDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "created": obj.get("created"), + "updated": obj.get("updated"), + "ignored": obj.get("ignored"), + "deleted": obj.get("deleted") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/sources_api_put_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/sources_api_put_response_dto.py new file mode 100644 index 0000000000..1db36bcd33 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/sources_api_put_response_dto.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from visier_platform_sdk.models.source_import_result_summary_dto import SourceImportResultSummaryDTO +from typing import Optional, Set +from typing_extensions import Self + +class SourcesAPIPutResponseDTO(BaseModel): + """ + SourcesAPIPutResponseDTO + """ # noqa: E501 + summary: Optional[SourceImportResultSummaryDTO] = Field(default=None, description="The changes made to the sources during the operation.") + __properties: ClassVar[List[str]] = ["summary"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SourcesAPIPutResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of summary + if self.summary: + _dict['summary'] = self.summary.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SourcesAPIPutResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "summary": SourceImportResultSummaryDTO.from_dict(obj["summary"]) if obj.get("summary") is not None else None + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/sql_like200_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/sql_like200_response.py new file mode 100644 index 0000000000..634f7c618e --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/sql_like200_response.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator +from typing import Any, List, Optional +from visier_platform_sdk.models.dataservices_query_cell_set_dto import DataservicesQueryCellSetDTO +from visier_platform_sdk.models.table_response_dto import TableResponseDTO +from pydantic import StrictStr, Field +from typing import Union, List, Set, Optional, Dict +from typing_extensions import Literal, Self + +SQLLIKE200RESPONSE_ONE_OF_SCHEMAS = ["DataservicesQueryCellSetDTO", "TableResponseDTO"] + +class SqlLike200Response(BaseModel): + """ + SqlLike200Response + """ + # data type: TableResponseDTO + oneof_schema_1_validator: Optional[TableResponseDTO] = None + # data type: DataservicesQueryCellSetDTO + oneof_schema_2_validator: Optional[DataservicesQueryCellSetDTO] = None + actual_instance: Optional[Union[DataservicesQueryCellSetDTO, TableResponseDTO]] = None + one_of_schemas: Set[str] = { "DataservicesQueryCellSetDTO", "TableResponseDTO" } + + model_config = ConfigDict( + validate_assignment=True, + protected_namespaces=(), + ) + + + def __init__(self, *args, **kwargs) -> None: + if args: + if len(args) > 1: + raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") + if kwargs: + raise ValueError("If a position argument is used, keyword arguments cannot be used.") + super().__init__(actual_instance=args[0]) + else: + super().__init__(**kwargs) + + @field_validator('actual_instance') + def actual_instance_must_validate_oneof(cls, v): + instance = SqlLike200Response.model_construct() + error_messages = [] + match = 0 + # validate data type: TableResponseDTO + if not isinstance(v, TableResponseDTO): + error_messages.append(f"Error! Input type `{type(v)}` is not `TableResponseDTO`") + else: + match += 1 + # validate data type: DataservicesQueryCellSetDTO + if not isinstance(v, DataservicesQueryCellSetDTO): + error_messages.append(f"Error! Input type `{type(v)}` is not `DataservicesQueryCellSetDTO`") + else: + match += 1 + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when setting `actual_instance` in SqlLike200Response with oneOf schemas: DataservicesQueryCellSetDTO, TableResponseDTO. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when setting `actual_instance` in SqlLike200Response with oneOf schemas: DataservicesQueryCellSetDTO, TableResponseDTO. Details: " + ", ".join(error_messages)) + else: + return v + + @classmethod + def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: + return cls.from_json(json.dumps(obj)) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Returns the object represented by the json string""" + instance = cls.model_construct() + error_messages = [] + match = 0 + + # deserialize data into TableResponseDTO + try: + instance.actual_instance = TableResponseDTO.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + # deserialize data into DataservicesQueryCellSetDTO + try: + instance.actual_instance = DataservicesQueryCellSetDTO.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) + + if match > 1: + # more than 1 match + raise ValueError("Multiple matches found when deserializing the JSON string into SqlLike200Response with oneOf schemas: DataservicesQueryCellSetDTO, TableResponseDTO. Details: " + ", ".join(error_messages)) + elif match == 0: + # no match + raise ValueError("No match found when deserializing the JSON string into SqlLike200Response with oneOf schemas: DataservicesQueryCellSetDTO, TableResponseDTO. Details: " + ", ".join(error_messages)) + else: + return instance + + def to_json(self) -> str: + """Returns the JSON representation of the actual instance""" + if self.actual_instance is None: + return "null" + + if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): + return self.actual_instance.to_json() + else: + return json.dumps(self.actual_instance) + + def to_dict(self) -> Optional[Union[Dict[str, Any], DataservicesQueryCellSetDTO, TableResponseDTO]]: + """Returns the dict representation of the actual instance""" + if self.actual_instance is None: + return None + + if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): + return self.actual_instance.to_dict() + else: + # primitive type + return self.actual_instance + + def to_str(self) -> str: + """Returns the string representation of the actual instance""" + return pprint.pformat(self.model_dump()) + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/status.py b/src/visier_platform_sdk/visier_platform_sdk/models/status.py new file mode 100644 index 0000000000..cbcb534620 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/status.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class Status(BaseModel): + """ + The response structure for errors. + """ # noqa: E501 + localized_message: Optional[StrictStr] = Field(default=None, description="Localized error message describing the root cause of the error.", alias="localizedMessage") + code: Optional[StrictStr] = Field(default=None, description="Error classification.") + message: Optional[StrictStr] = Field(default=None, description="Not used.") + rci: Optional[StrictStr] = Field(default=None, description="Optional root cause identifier.") + user_error: Optional[StrictBool] = Field(default=None, description="Indicates whether the error is a user error.", alias="userError") + __properties: ClassVar[List[str]] = ["localizedMessage", "code", "message", "rci", "userError"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Status from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Status from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "localizedMessage": obj.get("localizedMessage"), + "code": obj.get("code"), + "message": obj.get("message"), + "rci": obj.get("rci"), + "userError": obj.get("userError") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/systemstatus_system_status_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/systemstatus_system_status_dto.py new file mode 100644 index 0000000000..52cb2c0773 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/systemstatus_system_status_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SystemstatusSystemStatusDTO(BaseModel): + """ + SystemstatusSystemStatusDTO + """ # noqa: E501 + overall: Optional[StrictStr] = Field(default=None, description="The overall status of Visier's platform and services.") + __properties: ClassVar[List[str]] = ["overall"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SystemstatusSystemStatusDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SystemstatusSystemStatusDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "overall": obj.get("overall") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/systemstatus_vee_status_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/systemstatus_vee_status_dto.py new file mode 100644 index 0000000000..bf4a814841 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/systemstatus_vee_status_dto.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SystemstatusVeeStatusDTO(BaseModel): + """ + SystemstatusVeeStatusDTO + """ # noqa: E501 + overall: Optional[StrictStr] = Field(default=None, description="The overall status of Vee.") + __properties: ClassVar[List[str]] = ["overall"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SystemstatusVeeStatusDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SystemstatusVeeStatusDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "overall": obj.get("overall") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/table_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/table_response_dto.py new file mode 100644 index 0000000000..18e1761e32 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/table_response_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class TableResponseDTO(BaseModel): + """ + TableResponseDTO + """ # noqa: E501 + header: Optional[Dict[str, StrictStr]] = Field(default=None, description="Description of the columns in the result set.") + rows: Optional[List[Dict[str, StrictStr]]] = Field(default=None, description="Result rows in key-value format.") + __properties: ClassVar[List[str]] = ["header", "rows"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TableResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TableResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "header": obj.get("header"), + "rows": obj.get("rows") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/token_response.py b/src/visier_platform_sdk/visier_platform_sdk/models/token_response.py new file mode 100644 index 0000000000..067f62a0c6 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/token_response.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class TokenResponse(BaseModel): + """ + TokenResponse + """ # noqa: E501 + access_token: Optional[StrictStr] = Field(default=None, description="The access token to be used for API calls.") + refresh_token: Optional[StrictStr] = Field(default=None, description="The token used to obtain new access tokens.") + id_token: Optional[StrictStr] = Field(default=None, description="The ID token containing user identity information.") + token_type: Optional[StrictStr] = Field(default=None, description="The type of the token, typically \"Bearer\".") + expires_in: Optional[StrictInt] = Field(default=None, description="The duration in seconds for which the access token is valid.") + __properties: ClassVar[List[str]] = ["access_token", "refresh_token", "id_token", "token_type", "expires_in"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TokenResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TokenResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "access_token": obj.get("access_token"), + "refresh_token": obj.get("refresh_token"), + "id_token": obj.get("id_token"), + "token_type": obj.get("token_type"), + "expires_in": obj.get("expires_in") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/models/user_creation_api_response_dto.py b/src/visier_platform_sdk/visier_platform_sdk/models/user_creation_api_response_dto.py new file mode 100644 index 0000000000..cb0dfef5b7 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/models/user_creation_api_response_dto.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class UserCreationAPIResponseDTO(BaseModel): + """ + UserCreationAPIResponseDTO + """ # noqa: E501 + user_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the user.", alias="userId") + username: Optional[StrictStr] = Field(default=None, description="The user's username. This is typically the user's email, such as john@jupiter.com.") + display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name to display within Visier. For example, \"John Smith\".", alias="displayName") + employee_id: Optional[StrictStr] = Field(default=None, description="If applicable, and if available, the user employee ID in the data.", alias="employeeId") + account_enabled: Optional[StrictStr] = Field(default=None, description="If true, the user account is enabled.", alias="accountEnabled") + email: Optional[StrictStr] = Field(default=None, description="The user's email address.") + __properties: ClassVar[List[str]] = ["userId", "username", "displayName", "employeeId", "accountEnabled", "email"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UserCreationAPIResponseDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UserCreationAPIResponseDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "userId": obj.get("userId"), + "username": obj.get("username"), + "displayName": obj.get("displayName"), + "employeeId": obj.get("employeeId"), + "accountEnabled": obj.get("accountEnabled"), + "email": obj.get("email") + }) + return _obj + + diff --git a/src/visier_platform_sdk/visier_platform_sdk/py.typed b/src/visier_platform_sdk/visier_platform_sdk/py.typed new file mode 100644 index 0000000000..e69de29bb2 diff --git a/src/visier_platform_sdk/visier_platform_sdk/rest.py b/src/visier_platform_sdk/visier_platform_sdk/rest.py new file mode 100644 index 0000000000..f4f46c3638 --- /dev/null +++ b/src/visier_platform_sdk/visier_platform_sdk/rest.py @@ -0,0 +1,259 @@ +# coding: utf-8 + +""" + API Reference + + 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. + + The version of the OpenAPI document: 22222222.99201.1892 + Contact: alpine@visier.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import io +import json +import re +import ssl + +import urllib3 + +from visier_platform_sdk.exceptions import ApiException, ApiValueError + +SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"} +RESTResponseType = urllib3.HTTPResponse + + +def is_socks_proxy_url(url): + if url is None: + return False + split_section = url.split("://") + if len(split_section) < 2: + return False + else: + return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES + + +class RESTResponse(io.IOBase): + + def __init__(self, resp) -> None: + self.response = resp + self.status = resp.status + self.reason = resp.reason + self.data = None + + def read(self): + if self.data is None: + self.data = self.response.data + return self.data + + def getheaders(self): + """Returns a dictionary of the response headers.""" + return self.response.headers + + def getheader(self, name, default=None): + """Returns a given response header.""" + return self.response.headers.get(name, default) + + +class RESTClientObject: + + def __init__(self, configuration) -> None: + # urllib3.PoolManager will pass all kw parameters to connectionpool + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 + # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 + + # cert_reqs + if configuration.verify_ssl: + cert_reqs = ssl.CERT_REQUIRED + else: + cert_reqs = ssl.CERT_NONE + + pool_args = { + "cert_reqs": cert_reqs, + "ca_certs": configuration.ssl_ca_cert, + "cert_file": configuration.cert_file, + "key_file": configuration.key_file, + "ca_cert_data": configuration.ca_cert_data, + } + if configuration.assert_hostname is not None: + pool_args['assert_hostname'] = ( + configuration.assert_hostname + ) + + if configuration.retries is not None: + pool_args['retries'] = configuration.retries + + if configuration.tls_server_name: + pool_args['server_hostname'] = configuration.tls_server_name + + + if configuration.socket_options is not None: + pool_args['socket_options'] = configuration.socket_options + + if configuration.connection_pool_maxsize is not None: + pool_args['maxsize'] = configuration.connection_pool_maxsize + + # https pool manager + self.pool_manager: urllib3.PoolManager + + if configuration.proxy: + if is_socks_proxy_url(configuration.proxy): + from urllib3.contrib.socks import SOCKSProxyManager + pool_args["proxy_url"] = configuration.proxy + pool_args["headers"] = configuration.proxy_headers + self.pool_manager = SOCKSProxyManager(**pool_args) + else: + pool_args["proxy_url"] = configuration.proxy + pool_args["proxy_headers"] = configuration.proxy_headers + self.pool_manager = urllib3.ProxyManager(**pool_args) + else: + self.pool_manager = urllib3.PoolManager(**pool_args) + + def request( + self, + method, + url, + headers=None, + body=None, + post_params=None, + _request_timeout=None + ): + """Perform requests. + + :param method: http request method + :param url: http request url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + """ + method = method.upper() + assert method in [ + 'GET', + 'HEAD', + 'DELETE', + 'POST', + 'PUT', + 'PATCH', + 'OPTIONS' + ] + + if post_params and body: + raise ApiValueError( + "body parameter cannot be used with post_params parameter." + ) + + post_params = post_params or {} + headers = headers or {} + + timeout = None + if _request_timeout: + if isinstance(_request_timeout, (int, float)): + timeout = urllib3.Timeout(total=_request_timeout) + elif ( + isinstance(_request_timeout, tuple) + and len(_request_timeout) == 2 + ): + timeout = urllib3.Timeout( + connect=_request_timeout[0], + read=_request_timeout[1] + ) + + try: + # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` + if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: + + # no content type provided or payload is json + content_type = headers.get('Content-Type') + if ( + not content_type + or re.search('json', content_type, re.IGNORECASE) + ): + request_body = None + if body is not None: + request_body = json.dumps(body) + r = self.pool_manager.request( + method, + url, + body=request_body, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif content_type == 'application/x-www-form-urlencoded': + r = self.pool_manager.request( + method, + url, + fields=post_params, + encode_multipart=False, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif content_type == 'multipart/form-data': + # must del headers['Content-Type'], or the correct + # Content-Type which generated by urllib3 will be + # overwritten. + del headers['Content-Type'] + # Ensures that dict objects are serialized + post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params] + r = self.pool_manager.request( + method, + url, + fields=post_params, + encode_multipart=True, + timeout=timeout, + headers=headers, + preload_content=False + ) + # Pass a `string` parameter directly in the body to support + # other content types than JSON when `body` argument is + # provided in serialized form. + elif isinstance(body, str) or isinstance(body, bytes): + r = self.pool_manager.request( + method, + url, + body=body, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif headers['Content-Type'].startswith('text/') and isinstance(body, bool): + request_body = "true" if body else "false" + r = self.pool_manager.request( + method, + url, + body=request_body, + preload_content=False, + timeout=timeout, + headers=headers) + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) + # For `GET`, `HEAD` + else: + r = self.pool_manager.request( + method, + url, + fields={}, + timeout=timeout, + headers=headers, + preload_content=False + ) + except urllib3.exceptions.SSLError as e: + msg = "\n".join([type(e).__name__, str(e)]) + raise ApiException(status=0, reason=msg) + + return RESTResponse(r)