visier-platform-sdk 22222222.99200.21494__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of visier-platform-sdk might be problematic. Click here for more details.
- visier_platform_sdk/__init__.py +1404 -0
- visier_platform_sdk/api/__init__.py +43 -0
- visier_platform_sdk/api/basic_authentication_api.py +625 -0
- visier_platform_sdk/api/benchmarks_api.py +936 -0
- visier_platform_sdk/api/concepts_v2_api.py +2307 -0
- visier_platform_sdk/api/consolidated_analytics_api.py +3265 -0
- visier_platform_sdk/api/data_and_job_handling_api.py +8380 -0
- visier_platform_sdk/api/data_intake_api.py +1866 -0
- visier_platform_sdk/api/data_model_api.py +13164 -0
- visier_platform_sdk/api/data_query_api.py +1226 -0
- visier_platform_sdk/api/data_upload_api.py +343 -0
- visier_platform_sdk/api/data_version_export_api.py +1724 -0
- visier_platform_sdk/api/dimensions_api.py +3050 -0
- visier_platform_sdk/api/dimensions_v2_api.py +2344 -0
- visier_platform_sdk/api/direct_data_intake_api.py +3039 -0
- visier_platform_sdk/api/email_domains_api.py +843 -0
- visier_platform_sdk/api/encryption_keys_api.py +835 -0
- visier_platform_sdk/api/jobs_library_api.py +1168 -0
- visier_platform_sdk/api/network_subnets_api.py +1170 -0
- visier_platform_sdk/api/o_auth2_api.py +1036 -0
- visier_platform_sdk/api/object_configuration_api.py +1752 -0
- visier_platform_sdk/api/permissions_api.py +4295 -0
- visier_platform_sdk/api/pgp_keys_api.py +1161 -0
- visier_platform_sdk/api/planning_data_load_api.py +740 -0
- visier_platform_sdk/api/production_versions_api.py +944 -0
- visier_platform_sdk/api/profiles_api.py +2873 -0
- visier_platform_sdk/api/projects_api.py +2128 -0
- visier_platform_sdk/api/release_version_configuration_api.py +835 -0
- visier_platform_sdk/api/reporting_api.py +1757 -0
- visier_platform_sdk/api/search_api.py +356 -0
- visier_platform_sdk/api/skills_library_api.py +2632 -0
- visier_platform_sdk/api/source_files_download_api.py +335 -0
- visier_platform_sdk/api/sources_api.py +652 -0
- visier_platform_sdk/api/system_status_api.py +570 -0
- visier_platform_sdk/api/tenants_v1_api.py +2836 -0
- visier_platform_sdk/api/tenants_v2_api.py +1595 -0
- visier_platform_sdk/api/user_groups_v2_api.py +2332 -0
- visier_platform_sdk/api/users_v1_api.py +6157 -0
- visier_platform_sdk/api/users_v2_api.py +973 -0
- visier_platform_sdk/api/vee_api.py +1161 -0
- visier_platform_sdk/api/webhooks_api.py +2281 -0
- visier_platform_sdk/api_client.py +811 -0
- visier_platform_sdk/api_response.py +21 -0
- visier_platform_sdk/configuration.py +808 -0
- visier_platform_sdk/exceptions.py +217 -0
- visier_platform_sdk/models/__init__.py +657 -0
- visier_platform_sdk/models/accessible_tenant_profile_assignment_request_dto.py +102 -0
- visier_platform_sdk/models/accessible_tenant_profile_assignment_response_dto.py +128 -0
- visier_platform_sdk/models/accessible_tenant_profile_revoke_request_dto.py +98 -0
- visier_platform_sdk/models/accessible_tenant_profile_revoke_response_dto.py +125 -0
- visier_platform_sdk/models/additional_capabilities_dto.py +88 -0
- visier_platform_sdk/models/admin_capability_config_dto.py +90 -0
- visier_platform_sdk/models/adp_auth_params_dto.py +88 -0
- visier_platform_sdk/models/aggregation_query_dto.py +128 -0
- visier_platform_sdk/models/aggregation_query_execution_dto.py +98 -0
- visier_platform_sdk/models/aggregation_query_source_dto.py +96 -0
- visier_platform_sdk/models/aggregation_query_source_metric_dto.py +94 -0
- visier_platform_sdk/models/aggregation_query_source_metrics_dto.py +96 -0
- visier_platform_sdk/models/aggregation_type_option_dto.py +96 -0
- visier_platform_sdk/models/aggregation_type_parameter_dto.py +102 -0
- visier_platform_sdk/models/aggregation_type_parameter_value_dto.py +90 -0
- visier_platform_sdk/models/all_permissions_assigned_for_local_tenant_dto.py +96 -0
- visier_platform_sdk/models/all_profile_assigned_for_accessible_tenant_dto.py +96 -0
- visier_platform_sdk/models/all_profile_assigned_for_local_tenant_dto.py +96 -0
- visier_platform_sdk/models/all_tenants_status_apidto.py +100 -0
- visier_platform_sdk/models/all_user_groups_assigned_for_local_tenant_dto.py +96 -0
- visier_platform_sdk/models/all_users_get_api_response_dto.py +100 -0
- visier_platform_sdk/models/analytic_object_definition_dto.py +102 -0
- visier_platform_sdk/models/analytic_object_dto.py +132 -0
- visier_platform_sdk/models/analytic_object_filter_dto.py +94 -0
- visier_platform_sdk/models/analytic_object_filter_list_dto.py +96 -0
- visier_platform_sdk/models/analytic_object_names_dto.py +88 -0
- visier_platform_sdk/models/analytic_object_reference_dto.py +88 -0
- visier_platform_sdk/models/analytic_object_reference_list_dto.py +96 -0
- visier_platform_sdk/models/analytic_object_request_dto.py +96 -0
- visier_platform_sdk/models/analytic_object_with_context_dto.py +98 -0
- visier_platform_sdk/models/analytic_objects_dto.py +96 -0
- visier_platform_sdk/models/any.py +101 -0
- visier_platform_sdk/models/api_error.py +92 -0
- visier_platform_sdk/models/assign_connector_credential_request.py +96 -0
- visier_platform_sdk/models/assign_connector_credentials_by_tenant_response_dto.py +112 -0
- visier_platform_sdk/models/assign_connector_credentials_response_dto.py +96 -0
- visier_platform_sdk/models/assign_connector_with_credentials_response_dto.py +98 -0
- visier_platform_sdk/models/assign_revoke_permission_by_permission_dto.py +102 -0
- visier_platform_sdk/models/assign_revoke_permission_by_tenant_dto.py +114 -0
- visier_platform_sdk/models/assign_revoke_permission_by_user_dto.py +92 -0
- visier_platform_sdk/models/assign_revoke_permission_request_dto.py +90 -0
- visier_platform_sdk/models/assign_revoke_permissions_request_dto.py +102 -0
- visier_platform_sdk/models/assign_revoke_permissions_response_dto.py +96 -0
- visier_platform_sdk/models/assigned_credential_info_response_dto.py +92 -0
- visier_platform_sdk/models/bamboo_auth_params_dto.py +90 -0
- visier_platform_sdk/models/basic_information_dto.py +102 -0
- visier_platform_sdk/models/basic_s3_auth_params_dto.py +96 -0
- visier_platform_sdk/models/batch_tenant_provision_apidto.py +96 -0
- visier_platform_sdk/models/benchmark_info.py +92 -0
- visier_platform_sdk/models/benchmark_value.py +108 -0
- visier_platform_sdk/models/big_query_auth_params_dto.py +104 -0
- visier_platform_sdk/models/big_query_service_account_params_dto.py +90 -0
- visier_platform_sdk/models/bulk_change_response_dto.py +106 -0
- visier_platform_sdk/models/bulk_data_access_set_response_dto.py +106 -0
- visier_platform_sdk/models/business_location_dto.py +90 -0
- visier_platform_sdk/models/calculated_property_type_dto.py +90 -0
- visier_platform_sdk/models/calculated_selection_concept_dto.py +104 -0
- visier_platform_sdk/models/calculation_concept_configuration_dto.py +96 -0
- visier_platform_sdk/models/calculation_concept_configuration_map_dto.py +96 -0
- visier_platform_sdk/models/calculation_concept_dto.py +96 -0
- visier_platform_sdk/models/calculation_concept_list_dto.py +96 -0
- visier_platform_sdk/models/cancel_job_batch_from_job_id_dto.py +88 -0
- visier_platform_sdk/models/capabilities_dto.py +92 -0
- visier_platform_sdk/models/capability_dto.py +92 -0
- visier_platform_sdk/models/capability_group_dto.py +146 -0
- visier_platform_sdk/models/cell_distribution_bin_dto.py +90 -0
- visier_platform_sdk/models/cell_distribution_options_dto.py +88 -0
- visier_platform_sdk/models/cell_dto.py +102 -0
- visier_platform_sdk/models/cell_set_axis_dto.py +102 -0
- visier_platform_sdk/models/cell_set_axis_position_dto.py +92 -0
- visier_platform_sdk/models/cell_set_dto.py +114 -0
- visier_platform_sdk/models/cell_set_or_error_dto.py +98 -0
- visier_platform_sdk/models/clone_files_into_source_parameters_dto.py +96 -0
- visier_platform_sdk/models/cohort_filter_dto.py +100 -0
- visier_platform_sdk/models/commit_and_publish_operation_response_dto.py +92 -0
- visier_platform_sdk/models/commit_dto.py +92 -0
- visier_platform_sdk/models/concept_configuration_result_dto.py +92 -0
- visier_platform_sdk/models/concept_definition_dto.py +108 -0
- visier_platform_sdk/models/concept_delete_request_dto.py +96 -0
- visier_platform_sdk/models/concept_delete_with_context_dto.py +98 -0
- visier_platform_sdk/models/concept_request_dto.py +96 -0
- visier_platform_sdk/models/concept_response_dto.py +96 -0
- visier_platform_sdk/models/concept_type_details_dto.py +104 -0
- visier_platform_sdk/models/concept_with_context_dto.py +98 -0
- visier_platform_sdk/models/connector.py +98 -0
- visier_platform_sdk/models/connector_info_response_dto.py +92 -0
- visier_platform_sdk/models/connector_setting_request_dto.py +90 -0
- visier_platform_sdk/models/connector_setting_response_dto.py +92 -0
- visier_platform_sdk/models/connector_settings_response_dto.py +102 -0
- visier_platform_sdk/models/consolidated_analytics_api_excluded_source_list_dto.py +88 -0
- visier_platform_sdk/models/consolidated_analytics_api_source_tenant_list_dto.py +88 -0
- visier_platform_sdk/models/consolidated_analytics_api_tenant_create_request_dto.py +88 -0
- visier_platform_sdk/models/consolidated_analytics_api_tenant_list_response_dto.py +88 -0
- visier_platform_sdk/models/consolidated_analytics_api_tenant_with_details.py +92 -0
- visier_platform_sdk/models/consolidated_analytics_api_tenant_with_details_list_response_dto.py +96 -0
- visier_platform_sdk/models/consolidated_analytics_job_request_dto.py +88 -0
- visier_platform_sdk/models/content_package_dto.py +92 -0
- visier_platform_sdk/models/copy_s3_auth_params_dto.py +88 -0
- visier_platform_sdk/models/create_data_access_set_request_dto.py +96 -0
- visier_platform_sdk/models/credential_creation_api_response_dto.py +102 -0
- visier_platform_sdk/models/currencies_dto.py +96 -0
- visier_platform_sdk/models/currency_dto.py +94 -0
- visier_platform_sdk/models/currency_rate_dto.py +96 -0
- visier_platform_sdk/models/currency_rates_dto.py +96 -0
- visier_platform_sdk/models/custom_property_dto.py +90 -0
- visier_platform_sdk/models/custom_tenant_property_dto.py +90 -0
- visier_platform_sdk/models/data_access_set_dto.py +104 -0
- visier_platform_sdk/models/data_access_set_error_dto.py +90 -0
- visier_platform_sdk/models/data_access_set_failure_dto.py +96 -0
- visier_platform_sdk/models/data_access_set_success_dto.py +90 -0
- visier_platform_sdk/models/data_categories_response_dto.py +96 -0
- visier_platform_sdk/models/data_category_response_dto.py +92 -0
- visier_platform_sdk/models/data_load_request.py +92 -0
- visier_platform_sdk/models/data_load_request_model.py +90 -0
- visier_platform_sdk/models/data_load_response.py +88 -0
- visier_platform_sdk/models/data_model_analytic_object_dto.py +130 -0
- visier_platform_sdk/models/data_provider_auth_information_dto.py +104 -0
- visier_platform_sdk/models/data_provider_auth_params_dto.py +344 -0
- visier_platform_sdk/models/data_provider_basic_information_dto.py +90 -0
- visier_platform_sdk/models/data_provider_basic_metadata_dto.py +88 -0
- visier_platform_sdk/models/data_security_profile_dto.py +134 -0
- visier_platform_sdk/models/data_transfer_result_detail.py +94 -0
- visier_platform_sdk/models/data_version_and_date_dto.py +90 -0
- visier_platform_sdk/models/data_version_export_column_dto.py +94 -0
- visier_platform_sdk/models/data_version_export_data_version_summary_dto.py +92 -0
- visier_platform_sdk/models/data_version_export_data_versions_dto.py +96 -0
- visier_platform_sdk/models/data_version_export_dto.py +108 -0
- visier_platform_sdk/models/data_version_export_file_dto.py +106 -0
- visier_platform_sdk/models/data_version_export_job_status_dto.py +94 -0
- visier_platform_sdk/models/data_version_export_part_file_dto.py +90 -0
- visier_platform_sdk/models/data_version_export_schedule_job_request_dto.py +90 -0
- visier_platform_sdk/models/data_version_export_schedule_job_response_dto.py +88 -0
- visier_platform_sdk/models/data_version_export_table_dto.py +101 -0
- visier_platform_sdk/models/data_version_exports_dto.py +96 -0
- visier_platform_sdk/models/data_version_object.py +92 -0
- visier_platform_sdk/models/databricks_auth_params_dto.py +94 -0
- visier_platform_sdk/models/date_range_dto.py +90 -0
- visier_platform_sdk/models/dayforce_v2_auth_params_dto.py +96 -0
- visier_platform_sdk/models/delete_permissions_request_dto.py +88 -0
- visier_platform_sdk/models/delete_user_group_v2_request.py +88 -0
- visier_platform_sdk/models/dependent_dto.py +92 -0
- visier_platform_sdk/models/description_entry.py +90 -0
- visier_platform_sdk/models/designer_dimension_filter_dto.py +100 -0
- visier_platform_sdk/models/designer_selection_concept_dto.py +96 -0
- visier_platform_sdk/models/dimension_change_definition_dto.py +94 -0
- visier_platform_sdk/models/dimension_change_definitions_by_tenant_dto.py +100 -0
- visier_platform_sdk/models/dimension_delete_request_dto.py +96 -0
- visier_platform_sdk/models/dimension_delete_with_context_dto.py +98 -0
- visier_platform_sdk/models/dimension_details_dto.py +98 -0
- visier_platform_sdk/models/dimension_dto.py +120 -0
- visier_platform_sdk/models/dimension_filter_dto.py +100 -0
- visier_platform_sdk/models/dimension_filter_list_dto.py +96 -0
- visier_platform_sdk/models/dimension_mapping_validation_dto.py +102 -0
- visier_platform_sdk/models/dimension_mapping_validation_execution_dto.py +90 -0
- visier_platform_sdk/models/dimension_member.py +139 -0
- visier_platform_sdk/models/dimension_member_dto.py +88 -0
- visier_platform_sdk/models/dimension_member_reference_dto.py +90 -0
- visier_platform_sdk/models/dimension_reference_dto.py +90 -0
- visier_platform_sdk/models/dimension_request_dto.py +96 -0
- visier_platform_sdk/models/dimension_response_dto.py +96 -0
- visier_platform_sdk/models/dimension_with_context_dto.py +98 -0
- visier_platform_sdk/models/dimensions_auth_params_dto.py +98 -0
- visier_platform_sdk/models/dimensions_change_definitions_dto.py +96 -0
- visier_platform_sdk/models/dimensions_dto.py +96 -0
- visier_platform_sdk/models/direct_data_job_config_dto.py +100 -0
- visier_platform_sdk/models/direct_data_job_status_response_dto.py +96 -0
- visier_platform_sdk/models/direct_data_list_transactions_response_dto.py +96 -0
- visier_platform_sdk/models/direct_data_load_config_dto.py +92 -0
- visier_platform_sdk/models/direct_data_schema_dto.py +96 -0
- visier_platform_sdk/models/direct_data_schema_field_dto.py +96 -0
- visier_platform_sdk/models/direct_data_transaction_dto.py +96 -0
- visier_platform_sdk/models/direct_data_transaction_start_response_dto.py +88 -0
- visier_platform_sdk/models/direct_data_upload_file_response_dto.py +92 -0
- visier_platform_sdk/models/disable_dv_model.py +96 -0
- visier_platform_sdk/models/disable_dv_request.py +92 -0
- visier_platform_sdk/models/disable_dv_response.py +100 -0
- visier_platform_sdk/models/dispatching_job_status_response.py +94 -0
- visier_platform_sdk/models/document_search_link_dto.py +90 -0
- visier_platform_sdk/models/download_source_files_dto.py +102 -0
- visier_platform_sdk/models/download_source_files_response_dto.py +90 -0
- visier_platform_sdk/models/dv_export_status.py +96 -0
- visier_platform_sdk/models/dynamic_dimension_filter_dto.py +112 -0
- visier_platform_sdk/models/dynamic_property_mapping_dto.py +106 -0
- visier_platform_sdk/models/element_ids_dto.py +88 -0
- visier_platform_sdk/models/email_domains_dto.py +90 -0
- visier_platform_sdk/models/error_dto.py +92 -0
- visier_platform_sdk/models/exclude_data_uploads_request.py +96 -0
- visier_platform_sdk/models/excluded_sources_body.py +88 -0
- visier_platform_sdk/models/execution_context_dto.py +90 -0
- visier_platform_sdk/models/export_production_versions_api_operation_parameters_dto.py +92 -0
- visier_platform_sdk/models/extract_data_and_load_dto.py +150 -0
- visier_platform_sdk/models/extracted_skill.py +94 -0
- visier_platform_sdk/models/extraction_job.py +94 -0
- visier_platform_sdk/models/extraction_job_and_status_response.py +104 -0
- visier_platform_sdk/models/extractor_credential_apidto.py +96 -0
- visier_platform_sdk/models/extractor_credentials_apidto.py +100 -0
- visier_platform_sdk/models/extractor_setting_apidto.py +100 -0
- visier_platform_sdk/models/extractor_setting_key_value_apidto.py +90 -0
- visier_platform_sdk/models/extractor_settings_apidto.py +96 -0
- visier_platform_sdk/models/failed_accessible_tenant_profile_assignment_dto.py +98 -0
- visier_platform_sdk/models/failed_change_dto.py +100 -0
- visier_platform_sdk/models/failed_local_tenant_profile_assignment_dto.py +94 -0
- visier_platform_sdk/models/failed_local_tenant_profile_revoke_dto.py +90 -0
- visier_platform_sdk/models/fusion_auth_params_dto.py +92 -0
- visier_platform_sdk/models/generate_impersonation_token_request.py +88 -0
- visier_platform_sdk/models/generate_key_request_dto.py +92 -0
- visier_platform_sdk/models/get_capabilities_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_content_packages_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_data_access_sets_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_data_security_objects_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_permissions_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_plan_list_response_dto.py +98 -0
- visier_platform_sdk/models/get_production_versions_api_response_dto.py +96 -0
- visier_platform_sdk/models/get_projects_api_response_dto.py +123 -0
- visier_platform_sdk/models/gong_auth_params_dto.py +90 -0
- visier_platform_sdk/models/google_sheets_auth_params_dto.py +94 -0
- visier_platform_sdk/models/google_workspace_auth_params_dto.py +96 -0
- visier_platform_sdk/models/greenhouse_auth_params_dto.py +88 -0
- visier_platform_sdk/models/hierarchy.py +92 -0
- visier_platform_sdk/models/hierarchy_property_dto.py +90 -0
- visier_platform_sdk/models/home_analysis_by_user_group_dto.py +90 -0
- visier_platform_sdk/models/icims_auth_params_dto.py +108 -0
- visier_platform_sdk/models/import_definition_apidto.py +92 -0
- visier_platform_sdk/models/import_definitions_apidto.py +100 -0
- visier_platform_sdk/models/include_data_uploads_request.py +96 -0
- visier_platform_sdk/models/inherited_access_config_dto.py +100 -0
- visier_platform_sdk/models/inherited_reference_member_filter_config_dto.py +90 -0
- visier_platform_sdk/models/internal_query_execution_options_dto.py +100 -0
- visier_platform_sdk/models/internal_s3_auth_params_dto.py +90 -0
- visier_platform_sdk/models/jdbc_auth_params_dto.py +92 -0
- visier_platform_sdk/models/jira_auth_params_dto.py +96 -0
- visier_platform_sdk/models/jira_connect_params_dto.py +92 -0
- visier_platform_sdk/models/job.py +121 -0
- visier_platform_sdk/models/job_cancellation_result_dto.py +110 -0
- visier_platform_sdk/models/job_cancellation_results_dto.py +96 -0
- visier_platform_sdk/models/job_entry.py +92 -0
- visier_platform_sdk/models/job_feedback_input.py +92 -0
- visier_platform_sdk/models/job_id_response.py +88 -0
- visier_platform_sdk/models/job_search_failure_output.py +94 -0
- visier_platform_sdk/models/job_search_input.py +88 -0
- visier_platform_sdk/models/job_search_output.py +106 -0
- visier_platform_sdk/models/job_standardization_input.py +98 -0
- visier_platform_sdk/models/job_standardization_input_skills.py +90 -0
- visier_platform_sdk/models/job_status_list_response.py +100 -0
- visier_platform_sdk/models/job_status_with_start_time.py +96 -0
- visier_platform_sdk/models/key_group_filter_dto.py +96 -0
- visier_platform_sdk/models/key_group_filter_item_dto.py +100 -0
- visier_platform_sdk/models/key_name.py +88 -0
- visier_platform_sdk/models/key_pair_delete_response_dto.py +88 -0
- visier_platform_sdk/models/key_pair_generate_request_dto.py +88 -0
- visier_platform_sdk/models/last_login_dto.py +88 -0
- visier_platform_sdk/models/level_dto.py +92 -0
- visier_platform_sdk/models/level_list_dto.py +96 -0
- visier_platform_sdk/models/leveled_details_dto.py +102 -0
- visier_platform_sdk/models/lever_auth_params_dto.py +88 -0
- visier_platform_sdk/models/lineage_dto.py +100 -0
- visier_platform_sdk/models/list_query_execution_dto.py +144 -0
- visier_platform_sdk/models/list_query_execution_options_dto.py +158 -0
- visier_platform_sdk/models/list_query_source_dto.py +94 -0
- visier_platform_sdk/models/list_response.py +101 -0
- visier_platform_sdk/models/local_tenant_profile_assignment_request_dto.py +92 -0
- visier_platform_sdk/models/local_tenant_profile_assignment_response_dto.py +118 -0
- visier_platform_sdk/models/local_tenant_profile_revoke_request_dto.py +88 -0
- visier_platform_sdk/models/local_tenant_profile_revoke_response_dto.py +106 -0
- visier_platform_sdk/models/location_search_failure_output.py +96 -0
- visier_platform_sdk/models/location_search_input.py +98 -0
- visier_platform_sdk/models/location_search_input1.py +92 -0
- visier_platform_sdk/models/location_search_output.py +106 -0
- visier_platform_sdk/models/location_search_successful_output.py +98 -0
- visier_platform_sdk/models/mask_message.py +88 -0
- visier_platform_sdk/models/medallia_auth_params_dto.py +94 -0
- visier_platform_sdk/models/member_dto.py +106 -0
- visier_platform_sdk/models/member_filter_config_dto.py +96 -0
- visier_platform_sdk/models/member_filter_dto.py +98 -0
- visier_platform_sdk/models/member_parameter_definition_dto.py +102 -0
- visier_platform_sdk/models/member_parameter_value_dto.py +98 -0
- visier_platform_sdk/models/member_selection_concept_dto.py +102 -0
- visier_platform_sdk/models/member_selection_dto.py +90 -0
- visier_platform_sdk/models/member_selection_list_dto.py +96 -0
- visier_platform_sdk/models/member_values_dto.py +105 -0
- visier_platform_sdk/models/members_dto.py +96 -0
- visier_platform_sdk/models/metric_definition_dto.py +114 -0
- visier_platform_sdk/models/metric_dto.py +122 -0
- visier_platform_sdk/models/metric_type_details_dto.py +92 -0
- visier_platform_sdk/models/metric_validation_summary_dto.py +92 -0
- visier_platform_sdk/models/metrics_dto.py +96 -0
- visier_platform_sdk/models/microsoft365_auth_params_dto.py +94 -0
- visier_platform_sdk/models/module_settings_dto.py +92 -0
- visier_platform_sdk/models/multiple_tenant_data_versions_details_dto.py +98 -0
- visier_platform_sdk/models/multiple_tenant_data_versions_list_dto.py +100 -0
- visier_platform_sdk/models/my_sql_auth_params_dto.py +98 -0
- visier_platform_sdk/models/namely_auth_params_dto.py +88 -0
- visier_platform_sdk/models/network_subnets_message_request.py +90 -0
- visier_platform_sdk/models/network_subnets_message_response.py +88 -0
- visier_platform_sdk/models/numeric_parameter_definition_dto.py +98 -0
- visier_platform_sdk/models/numeric_parameter_value_dto.py +90 -0
- visier_platform_sdk/models/o_auth2_user_info_dto.py +117 -0
- visier_platform_sdk/models/o_auth2_user_subnet_info_dto.py +100 -0
- visier_platform_sdk/models/o_auth2_user_tenant_detail_dto.py +96 -0
- visier_platform_sdk/models/o_auth2_user_tenant_details_dto.py +96 -0
- visier_platform_sdk/models/o_auth2_user_tenant_properties_dto.py +88 -0
- visier_platform_sdk/models/object_change_failure_dto.py +98 -0
- visier_platform_sdk/models/object_change_success_dto.py +94 -0
- visier_platform_sdk/models/object_id_dto.py +90 -0
- visier_platform_sdk/models/object_reference_dto.py +110 -0
- visier_platform_sdk/models/objects_bulk_change_response_dto.py +106 -0
- visier_platform_sdk/models/oracle_db_auth_params_dto.py +96 -0
- visier_platform_sdk/models/output_entry.py +98 -0
- visier_platform_sdk/models/output_entry1.py +98 -0
- visier_platform_sdk/models/output_entry1_matches_inner.py +94 -0
- visier_platform_sdk/models/pair_dto.py +90 -0
- visier_platform_sdk/models/parameter_definition_dto.py +110 -0
- visier_platform_sdk/models/parent_child_details_dto.py +108 -0
- visier_platform_sdk/models/permission_assigned_by_tenant_dto.py +98 -0
- visier_platform_sdk/models/permission_assigned_for_local_tenant_dto.py +92 -0
- visier_platform_sdk/models/permission_assigned_user_dto.py +92 -0
- visier_platform_sdk/models/permission_assigned_users_dto.py +100 -0
- visier_platform_sdk/models/permission_bulk_operation_response_dto.py +106 -0
- visier_platform_sdk/models/permission_dto.py +114 -0
- visier_platform_sdk/models/permission_error_dto.py +90 -0
- visier_platform_sdk/models/permission_failure_dto.py +96 -0
- visier_platform_sdk/models/permission_response_dto.py +90 -0
- visier_platform_sdk/models/permission_success_dto.py +90 -0
- visier_platform_sdk/models/permissions_list_dto.py +96 -0
- visier_platform_sdk/models/permissions_to_user_group_for_tenant_dto.py +102 -0
- visier_platform_sdk/models/permissions_to_user_group_request_dto.py +90 -0
- visier_platform_sdk/models/permissions_to_user_groups_request_dto.py +96 -0
- visier_platform_sdk/models/perspective_configuration_dto.py +100 -0
- visier_platform_sdk/models/perspective_node_dto.py +100 -0
- visier_platform_sdk/models/plan_data_load_change_dto.py +94 -0
- visier_platform_sdk/models/plan_data_load_change_list_dto.py +98 -0
- visier_platform_sdk/models/plan_data_load_error_dto.py +92 -0
- visier_platform_sdk/models/plan_data_upload_response_dto.py +110 -0
- visier_platform_sdk/models/plan_info_dto.py +106 -0
- visier_platform_sdk/models/plan_item_dto.py +102 -0
- visier_platform_sdk/models/plan_parameter_definition_dto.py +94 -0
- visier_platform_sdk/models/plan_parameter_value_dto.py +94 -0
- visier_platform_sdk/models/plan_row_data_load_response_dto.py +114 -0
- visier_platform_sdk/models/plan_schema_dto.py +126 -0
- visier_platform_sdk/models/plan_segment_level_dto.py +96 -0
- visier_platform_sdk/models/plan_segment_level_member_dto.py +94 -0
- visier_platform_sdk/models/plan_segment_level_member_list_dto.py +100 -0
- visier_platform_sdk/models/plan_time_period_dto.py +90 -0
- visier_platform_sdk/models/plan_with_schema_dto.py +108 -0
- visier_platform_sdk/models/planning_concept_filter_context_dto.py +88 -0
- visier_platform_sdk/models/planning_hierarchy_filter_context_dto.py +92 -0
- visier_platform_sdk/models/planning_model_dto.py +92 -0
- visier_platform_sdk/models/planning_models_dto.py +96 -0
- visier_platform_sdk/models/planning_plan_context_dto.py +98 -0
- visier_platform_sdk/models/planning_plan_dto.py +123 -0
- visier_platform_sdk/models/planning_plans_dto.py +96 -0
- visier_platform_sdk/models/population_configuration_dto.py +115 -0
- visier_platform_sdk/models/prediction_dto.py +124 -0
- visier_platform_sdk/models/predictions_dto.py +96 -0
- visier_platform_sdk/models/process_concept_definition_dto.py +128 -0
- visier_platform_sdk/models/process_concept_member_dto.py +90 -0
- visier_platform_sdk/models/process_concept_member_list_dto.py +96 -0
- visier_platform_sdk/models/process_concept_metric_definition_dto.py +92 -0
- visier_platform_sdk/models/process_concept_metric_list_dto.py +96 -0
- visier_platform_sdk/models/process_concept_outcome_dto.py +114 -0
- visier_platform_sdk/models/process_concept_outcome_list_dto.py +96 -0
- visier_platform_sdk/models/process_concept_property_list_dto.py +96 -0
- visier_platform_sdk/models/process_concept_property_type_dto.py +92 -0
- visier_platform_sdk/models/process_concept_stage_dto.py +102 -0
- visier_platform_sdk/models/process_concept_stage_list_dto.py +96 -0
- visier_platform_sdk/models/processing_job.py +96 -0
- visier_platform_sdk/models/processing_job_and_status_response.py +104 -0
- visier_platform_sdk/models/processing_job_request_dto.py +96 -0
- visier_platform_sdk/models/processing_job_status_response.py +104 -0
- visier_platform_sdk/models/product_release_dto.py +94 -0
- visier_platform_sdk/models/product_releases_dto.py +96 -0
- visier_platform_sdk/models/product_version_dto.py +92 -0
- visier_platform_sdk/models/product_versions_dto.py +96 -0
- visier_platform_sdk/models/product_versions_update_failure_tenant_response_dto.py +94 -0
- visier_platform_sdk/models/product_versions_update_response_dto.py +106 -0
- visier_platform_sdk/models/product_versions_update_successful_tenant_response_dto.py +92 -0
- visier_platform_sdk/models/production_version_api_operation_request_dto.py +98 -0
- visier_platform_sdk/models/production_version_api_operation_response_dto.py +92 -0
- visier_platform_sdk/models/production_versions_api_operation_request_dto.py +104 -0
- visier_platform_sdk/models/production_versions_api_operation_response_dto.py +88 -0
- visier_platform_sdk/models/profile_assigned_for_accessible_tenant_dto.py +98 -0
- visier_platform_sdk/models/profile_assigned_for_local_tenant_dto.py +110 -0
- visier_platform_sdk/models/profile_get_api_response_dto.py +102 -0
- visier_platform_sdk/models/profiles_get_api_response_dto.py +96 -0
- visier_platform_sdk/models/project_commits_api_response_dto.py +96 -0
- visier_platform_sdk/models/project_dto.py +111 -0
- visier_platform_sdk/models/project_operation_request_dto.py +98 -0
- visier_platform_sdk/models/project_operation_response_dto.py +92 -0
- visier_platform_sdk/models/properties_change_definitions_dto.py +96 -0
- visier_platform_sdk/models/properties_delete_definitions_dto.py +100 -0
- visier_platform_sdk/models/properties_dto.py +96 -0
- visier_platform_sdk/models/property_access_config_dto.py +116 -0
- visier_platform_sdk/models/property_bulk_delete_response_dto.py +106 -0
- visier_platform_sdk/models/property_change_definition_dto.py +112 -0
- visier_platform_sdk/models/property_change_definitions_by_tenant_dto.py +100 -0
- visier_platform_sdk/models/property_column_dto.py +94 -0
- visier_platform_sdk/models/property_definition_dto.py +102 -0
- visier_platform_sdk/models/property_delete_definitions_by_tenant_dto.py +92 -0
- visier_platform_sdk/models/property_delete_failure_dto.py +117 -0
- visier_platform_sdk/models/property_delete_success_dto.py +113 -0
- visier_platform_sdk/models/property_dependency_dto.py +90 -0
- visier_platform_sdk/models/property_dependency_list_dto.py +96 -0
- visier_platform_sdk/models/property_dto.py +118 -0
- visier_platform_sdk/models/property_reference_dto.py +90 -0
- visier_platform_sdk/models/property_set_config_dto.py +102 -0
- visier_platform_sdk/models/property_type_details_dto.py +104 -0
- visier_platform_sdk/models/property_type_dto.py +98 -0
- visier_platform_sdk/models/public_key_dto.py +96 -0
- visier_platform_sdk/models/public_keys_dto.py +96 -0
- visier_platform_sdk/models/push_data_cancel_response.py +102 -0
- visier_platform_sdk/models/push_data_column_definition_dto.py +98 -0
- visier_platform_sdk/models/push_data_complete_request.py +90 -0
- visier_platform_sdk/models/push_data_complete_response.py +104 -0
- visier_platform_sdk/models/push_data_response.py +104 -0
- visier_platform_sdk/models/push_data_source_definition_dto.py +106 -0
- visier_platform_sdk/models/push_data_source_definitions_dto.py +96 -0
- visier_platform_sdk/models/put_project_commits_request.py +88 -0
- visier_platform_sdk/models/qualifying_path_dto.py +88 -0
- visier_platform_sdk/models/qualtrics_auth_params_dto.py +90 -0
- visier_platform_sdk/models/query_axis_dto.py +141 -0
- visier_platform_sdk/models/query_axis_options_dto.py +100 -0
- visier_platform_sdk/models/query_dimension_data_member_selection_dto.py +92 -0
- visier_platform_sdk/models/query_dimension_leaf_selection_dto.py +92 -0
- visier_platform_sdk/models/query_dimension_level_property_dto.py +108 -0
- visier_platform_sdk/models/query_dimension_level_selection_dto.py +96 -0
- visier_platform_sdk/models/query_dimension_member_selection_dto.py +102 -0
- visier_platform_sdk/models/query_execution_error_details_dto.py +94 -0
- visier_platform_sdk/models/query_execution_error_dto.py +100 -0
- visier_platform_sdk/models/query_execution_errors_dto.py +100 -0
- visier_platform_sdk/models/query_execution_options_dto.py +192 -0
- visier_platform_sdk/models/query_filter_dto.py +106 -0
- visier_platform_sdk/models/query_member_map_property_dto.py +94 -0
- visier_platform_sdk/models/query_member_map_selection_dto.py +104 -0
- visier_platform_sdk/models/query_numeric_ranges_dto.py +100 -0
- visier_platform_sdk/models/query_parameter_value_dto.py +110 -0
- visier_platform_sdk/models/query_property_dto.py +120 -0
- visier_platform_sdk/models/query_time_interval_dto.py +134 -0
- visier_platform_sdk/models/query_time_intervals_dto.py +150 -0
- visier_platform_sdk/models/question_categories_api_response_dto.py +96 -0
- visier_platform_sdk/models/question_category_api_response_dto.py +90 -0
- visier_platform_sdk/models/receiving_job.py +92 -0
- visier_platform_sdk/models/receiving_job_and_status_response.py +104 -0
- visier_platform_sdk/models/receiving_job_status_response.py +104 -0
- visier_platform_sdk/models/redshift_auth_params_dto.py +100 -0
- visier_platform_sdk/models/reduced_error_dto.py +88 -0
- visier_platform_sdk/models/reduced_tenant_code_error_dto.py +96 -0
- visier_platform_sdk/models/reduced_user_id_error_dto.py +94 -0
- visier_platform_sdk/models/related_analytic_object_dto.py +90 -0
- visier_platform_sdk/models/report_create_request_dto.py +90 -0
- visier_platform_sdk/models/report_delete_success_dto.py +88 -0
- visier_platform_sdk/models/report_dto.py +115 -0
- visier_platform_sdk/models/report_list_response_dto.py +96 -0
- visier_platform_sdk/models/result.py +96 -0
- visier_platform_sdk/models/role_modules_config_dto.py +88 -0
- visier_platform_sdk/models/salary_benchmark_input.py +100 -0
- visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py +96 -0
- visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py +106 -0
- visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py +110 -0
- visier_platform_sdk/models/salesforce_auth_params_dto.py +90 -0
- visier_platform_sdk/models/salesforce_v2_auth_params_dto.py +94 -0
- visier_platform_sdk/models/sample_question_api_response_dto.py +100 -0
- visier_platform_sdk/models/sample_questions_api_response_dto.py +96 -0
- visier_platform_sdk/models/scenario_info_dto.py +92 -0
- visier_platform_sdk/models/scenario_or_snapshot_dto.py +90 -0
- visier_platform_sdk/models/securable_dimension_dto.py +102 -0
- visier_platform_sdk/models/securable_property_dto.py +96 -0
- visier_platform_sdk/models/security_assignment_response_dto.py +96 -0
- visier_platform_sdk/models/selection_concept_configuration_dto.py +96 -0
- visier_platform_sdk/models/selection_concept_configuration_map_dto.py +96 -0
- visier_platform_sdk/models/selection_concept_dto.py +106 -0
- visier_platform_sdk/models/selection_concept_list_dto.py +96 -0
- visier_platform_sdk/models/selection_concept_reference_dto.py +90 -0
- visier_platform_sdk/models/selection_concepts_dto.py +96 -0
- visier_platform_sdk/models/service_now_auth_params_dto.py +92 -0
- visier_platform_sdk/models/service_now_v2_auth_params_dto.py +96 -0
- visier_platform_sdk/models/servicing_capability_proto_enum_access_lookup_dto.py +96 -0
- visier_platform_sdk/models/servicing_direct_data_upload_file_response_dto.py +92 -0
- visier_platform_sdk/models/set_connector_setting_request_dto.py +98 -0
- visier_platform_sdk/models/set_connector_setting_response_dto.py +112 -0
- visier_platform_sdk/models/set_connector_settings_request_dto.py +96 -0
- visier_platform_sdk/models/set_connector_settings_response_dto.py +96 -0
- visier_platform_sdk/models/shareable_data_access_set.py +88 -0
- visier_platform_sdk/models/simple_document_header_search_response_dto.py +96 -0
- visier_platform_sdk/models/simple_document_header_search_result_dto.py +98 -0
- visier_platform_sdk/models/simple_property_type_dto.py +88 -0
- visier_platform_sdk/models/simple_user_dto.py +90 -0
- visier_platform_sdk/models/skill.py +106 -0
- visier_platform_sdk/models/skill_category.py +102 -0
- visier_platform_sdk/models/skill_category_entry.py +92 -0
- visier_platform_sdk/models/skill_entry.py +92 -0
- visier_platform_sdk/models/skill_extraction_input.py +93 -0
- visier_platform_sdk/models/skill_group.py +104 -0
- visier_platform_sdk/models/skill_group_entry.py +92 -0
- visier_platform_sdk/models/skill_match_input.py +91 -0
- visier_platform_sdk/models/slack_auth_params_dto.py +92 -0
- visier_platform_sdk/models/snapshot_query_execution_dto.py +144 -0
- visier_platform_sdk/models/snapshot_query_execution_options_dto.py +134 -0
- visier_platform_sdk/models/snowflake_auth_params_dto.py +100 -0
- visier_platform_sdk/models/sort_option_dto.py +100 -0
- visier_platform_sdk/models/source.py +98 -0
- visier_platform_sdk/models/source_import_result_summary_dto.py +94 -0
- visier_platform_sdk/models/sources_api_operation_request_dto.py +104 -0
- visier_platform_sdk/models/sources_api_put_response_dto.py +92 -0
- visier_platform_sdk/models/sql_like200_response.py +138 -0
- visier_platform_sdk/models/sql_like_query_execution_dto.py +94 -0
- visier_platform_sdk/models/sql_server_auth_params_dto.py +96 -0
- visier_platform_sdk/models/start_extraction_response.py +88 -0
- visier_platform_sdk/models/start_transfer_response.py +88 -0
- visier_platform_sdk/models/static_dimension_filter_dto.py +112 -0
- visier_platform_sdk/models/status.py +96 -0
- visier_platform_sdk/models/subject_missing_access_dto.py +102 -0
- visier_platform_sdk/models/success_factors_auth_params_dto.py +100 -0
- visier_platform_sdk/models/success_factors_o_auth_params_dto.py +92 -0
- visier_platform_sdk/models/successful_accessible_tenant_profile_assignment_dto.py +92 -0
- visier_platform_sdk/models/successful_change_dto.py +98 -0
- visier_platform_sdk/models/successful_local_tenant_profile_assignment_dto.py +88 -0
- visier_platform_sdk/models/synonym_list_dto.py +88 -0
- visier_platform_sdk/models/system_status_dto.py +88 -0
- visier_platform_sdk/models/table_response_dto.py +90 -0
- visier_platform_sdk/models/tag_map_element_dto.py +90 -0
- visier_platform_sdk/models/tag_reference_dto.py +88 -0
- visier_platform_sdk/models/tag_reference_list_dto.py +96 -0
- visier_platform_sdk/models/tags_dto.py +88 -0
- visier_platform_sdk/models/target_project_for_tenant_dto.py +90 -0
- visier_platform_sdk/models/target_project_for_tenants_list_dto.py +96 -0
- visier_platform_sdk/models/target_tenant_code_dto.py +90 -0
- visier_platform_sdk/models/tenant.py +100 -0
- visier_platform_sdk/models/tenant_and_credential.py +90 -0
- visier_platform_sdk/models/tenant_assignments_dto.py +114 -0
- visier_platform_sdk/models/tenant_code_body.py +88 -0
- visier_platform_sdk/models/tenant_code_error_dto.py +96 -0
- visier_platform_sdk/models/tenant_connector_settings_request_dto.py +98 -0
- visier_platform_sdk/models/tenant_data_upload_status_response_dto.py +98 -0
- visier_platform_sdk/models/tenant_data_upload_update_status_response_dto.py +94 -0
- visier_platform_sdk/models/tenant_data_uploads_list_response_dto.py +100 -0
- visier_platform_sdk/models/tenant_data_uploads_response_dto.py +98 -0
- visier_platform_sdk/models/tenant_data_uploads_update_response_dto.py +100 -0
- visier_platform_sdk/models/tenant_detail_apidto.py +130 -0
- visier_platform_sdk/models/tenant_details_traits_dto.py +112 -0
- visier_platform_sdk/models/tenant_encryption_key_details_dto.py +96 -0
- visier_platform_sdk/models/tenant_encryption_key_dto.py +94 -0
- visier_platform_sdk/models/tenant_management_api_get_response_dto.py +156 -0
- visier_platform_sdk/models/tenant_management_api_list_response_dto.py +100 -0
- visier_platform_sdk/models/tenant_management_api_update_request_dto.py +156 -0
- visier_platform_sdk/models/tenant_management_api_update_response_dto.py +136 -0
- visier_platform_sdk/models/tenant_module_dto.py +96 -0
- visier_platform_sdk/models/tenant_preview_entries_summary_dto.py +102 -0
- visier_platform_sdk/models/tenant_preview_entries_summary_list_dto.py +100 -0
- visier_platform_sdk/models/tenant_provision_apidto.py +110 -0
- visier_platform_sdk/models/tenant_status_apidto.py +94 -0
- visier_platform_sdk/models/time_shift_dto.py +112 -0
- visier_platform_sdk/models/token_response.py +96 -0
- visier_platform_sdk/models/ultimate_auth_params_dto.py +96 -0
- visier_platform_sdk/models/update_tenant_model.py +98 -0
- visier_platform_sdk/models/upload_to_exclude.py +102 -0
- visier_platform_sdk/models/upload_to_include.py +102 -0
- visier_platform_sdk/models/user_creation_api_request_dto.py +96 -0
- visier_platform_sdk/models/user_creation_api_response_dto.py +98 -0
- visier_platform_sdk/models/user_get_api_response_dto.py +122 -0
- visier_platform_sdk/models/user_group_assigned_for_local_tenant_dto.py +90 -0
- visier_platform_sdk/models/user_group_assignment_dto.py +88 -0
- visier_platform_sdk/models/user_group_change_definition_dto.py +108 -0
- visier_platform_sdk/models/user_group_change_dimension_filter_dto.py +104 -0
- visier_platform_sdk/models/user_group_change_failure_dto.py +96 -0
- visier_platform_sdk/models/user_group_change_filter_dto.py +100 -0
- visier_platform_sdk/models/user_group_change_member_selection_dto.py +90 -0
- visier_platform_sdk/models/user_group_change_response_dto.py +106 -0
- visier_platform_sdk/models/user_group_change_success_dto.py +94 -0
- visier_platform_sdk/models/user_group_change_users_dto.py +105 -0
- visier_platform_sdk/models/user_group_delete_dto.py +92 -0
- visier_platform_sdk/models/user_group_delete_failure_dto.py +96 -0
- visier_platform_sdk/models/user_group_delete_response_dto.py +106 -0
- visier_platform_sdk/models/user_group_delete_success_dto.py +92 -0
- visier_platform_sdk/models/user_group_filters_dto.py +96 -0
- visier_platform_sdk/models/user_group_get_api_response_dto.py +100 -0
- visier_platform_sdk/models/user_group_single_delete_response_dto.py +98 -0
- visier_platform_sdk/models/user_groups_change_dto.py +96 -0
- visier_platform_sdk/models/user_groups_delete_request_dto.py +96 -0
- visier_platform_sdk/models/user_groups_get_api_response_dto.py +100 -0
- visier_platform_sdk/models/user_groups_users_dto.py +100 -0
- visier_platform_sdk/models/user_groups_users_for_tenant_dto.py +98 -0
- visier_platform_sdk/models/user_id_error_dto.py +94 -0
- visier_platform_sdk/models/user_property_dto.py +88 -0
- visier_platform_sdk/models/user_security_assignments_dto.py +100 -0
- visier_platform_sdk/models/user_update_api_request_dto.py +96 -0
- visier_platform_sdk/models/users_api_error_message_dto.py +90 -0
- visier_platform_sdk/models/users_api_failure_dto.py +98 -0
- visier_platform_sdk/models/users_api_response_dto.py +106 -0
- visier_platform_sdk/models/users_api_success_dto.py +98 -0
- visier_platform_sdk/models/users_creation_api_request_dto.py +96 -0
- visier_platform_sdk/models/users_delete_api_request_dto.py +88 -0
- visier_platform_sdk/models/users_to_user_group_request_dto.py +90 -0
- visier_platform_sdk/models/users_to_user_groups_request_dto.py +102 -0
- visier_platform_sdk/models/users_update_api_request_dto.py +96 -0
- visier_platform_sdk/models/users_update_api_user_dto.py +98 -0
- visier_platform_sdk/models/v2_calculated_property_type_dto.py +92 -0
- visier_platform_sdk/models/v2_dimension_dto.py +118 -0
- visier_platform_sdk/models/v2_level_dto.py +102 -0
- visier_platform_sdk/models/v2_simple_property_type_dto.py +90 -0
- visier_platform_sdk/models/validity_range_dto.py +90 -0
- visier_platform_sdk/models/vee_clarification_dto.py +98 -0
- visier_platform_sdk/models/vee_conversation_dto.py +92 -0
- visier_platform_sdk/models/vee_conversation_state_dto.py +88 -0
- visier_platform_sdk/models/vee_corrections_dto.py +109 -0
- visier_platform_sdk/models/vee_data_dto.py +90 -0
- visier_platform_sdk/models/vee_feedback_dto.py +96 -0
- visier_platform_sdk/models/vee_options_dto.py +110 -0
- visier_platform_sdk/models/vee_question_change_definition_dto.py +100 -0
- visier_platform_sdk/models/vee_question_change_definitions_by_tenant_dto.py +100 -0
- visier_platform_sdk/models/vee_question_change_failure_dto.py +106 -0
- visier_platform_sdk/models/vee_question_change_success_dto.py +104 -0
- visier_platform_sdk/models/vee_question_delete_definitions_by_tenant_dto.py +92 -0
- visier_platform_sdk/models/vee_question_dto.py +102 -0
- visier_platform_sdk/models/vee_questions_bulk_change_response_dto.py +106 -0
- visier_platform_sdk/models/vee_questions_change_definitions_dto.py +96 -0
- visier_platform_sdk/models/vee_questions_delete_definitions_dto.py +96 -0
- visier_platform_sdk/models/vee_response_dto.py +132 -0
- visier_platform_sdk/models/vee_response_schema_dto.py +107 -0
- visier_platform_sdk/models/vee_response_schema_reference_dto.py +90 -0
- visier_platform_sdk/models/vee_sample_question_dto.py +94 -0
- visier_platform_sdk/models/vee_sample_question_library_dto.py +96 -0
- visier_platform_sdk/models/vee_status_code_dto.py +100 -0
- visier_platform_sdk/models/vee_status_dto.py +88 -0
- visier_platform_sdk/models/vee_visual_dto.py +92 -0
- visier_platform_sdk/models/vee_visual_options_dto.py +90 -0
- visier_platform_sdk/models/version_information_dto.py +102 -0
- visier_platform_sdk/models/webhook_basic_auth_credential_dto.py +90 -0
- visier_platform_sdk/models/webhook_credentials_dto.py +94 -0
- visier_platform_sdk/models/webhook_details_dto.py +104 -0
- visier_platform_sdk/models/webhook_dto.py +96 -0
- visier_platform_sdk/models/webhook_event_type_dto.py +88 -0
- visier_platform_sdk/models/webhook_message_response_dto.py +94 -0
- visier_platform_sdk/models/webhook_request_dto.py +98 -0
- visier_platform_sdk/models/webhooks_dto.py +96 -0
- visier_platform_sdk/models/willow_auth_params_dto.py +90 -0
- visier_platform_sdk/models/workday_auth_params_dto.py +118 -0
- visier_platform_sdk/models/workday_o_auth_params_dto.py +92 -0
- visier_platform_sdk/models/workday_raas_auth_params_dto.py +96 -0
- visier_platform_sdk/models/workday_refresh_token_params_dto.py +92 -0
- visier_platform_sdk/models/zoom_auth_params_dto.py +92 -0
- visier_platform_sdk/py.typed +0 -0
- visier_platform_sdk/rest.py +259 -0
- visier_platform_sdk-22222222.99200.21494.dist-info/METADATA +28 -0
- visier_platform_sdk-22222222.99200.21494.dist-info/RECORD +692 -0
- visier_platform_sdk-22222222.99200.21494.dist-info/WHEEL +5 -0
- visier_platform_sdk-22222222.99200.21494.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,3039 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
API Reference
|
|
5
|
+
|
|
6
|
+
Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 22222222.99200.21494
|
|
9
|
+
Contact: alpine@visier.com
|
|
10
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
|
+
|
|
12
|
+
Do not edit the class manually.
|
|
13
|
+
""" # noqa: E501
|
|
14
|
+
|
|
15
|
+
import warnings
|
|
16
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
17
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
18
|
+
from typing_extensions import Annotated
|
|
19
|
+
|
|
20
|
+
from pydantic import Field, StrictBytes, StrictStr
|
|
21
|
+
from typing import Optional, Tuple, Union
|
|
22
|
+
from typing_extensions import Annotated
|
|
23
|
+
from visier_platform_sdk.models.direct_data_job_status_response_dto import DirectDataJobStatusResponseDTO
|
|
24
|
+
from visier_platform_sdk.models.direct_data_list_transactions_response_dto import DirectDataListTransactionsResponseDTO
|
|
25
|
+
from visier_platform_sdk.models.direct_data_load_config_dto import DirectDataLoadConfigDTO
|
|
26
|
+
from visier_platform_sdk.models.direct_data_schema_dto import DirectDataSchemaDTO
|
|
27
|
+
from visier_platform_sdk.models.direct_data_transaction_start_response_dto import DirectDataTransactionStartResponseDTO
|
|
28
|
+
from visier_platform_sdk.models.direct_data_upload_file_response_dto import DirectDataUploadFileResponseDTO
|
|
29
|
+
from visier_platform_sdk.models.servicing_direct_data_upload_file_response_dto import ServicingDirectDataUploadFileResponseDTO
|
|
30
|
+
|
|
31
|
+
from visier_platform_sdk.api_client import ApiClient, RequestSerialized
|
|
32
|
+
from visier_platform_sdk.api_response import ApiResponse
|
|
33
|
+
from visier_platform_sdk.rest import RESTResponseType
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class DirectDataIntakeApi:
|
|
37
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
38
|
+
Ref: https://openapi-generator.tech
|
|
39
|
+
|
|
40
|
+
Do not edit the class manually.
|
|
41
|
+
"""
|
|
42
|
+
|
|
43
|
+
def __init__(self, api_client=None) -> None:
|
|
44
|
+
if api_client is None:
|
|
45
|
+
api_client = ApiClient.get_default()
|
|
46
|
+
self.api_client = api_client
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
@validate_call
|
|
50
|
+
def commit_transaction(
|
|
51
|
+
self,
|
|
52
|
+
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.")],
|
|
53
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")],
|
|
54
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
55
|
+
_request_timeout: Union[
|
|
56
|
+
None,
|
|
57
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
58
|
+
Tuple[
|
|
59
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
60
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
61
|
+
]
|
|
62
|
+
] = None,
|
|
63
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
64
|
+
_content_type: Optional[StrictStr] = None,
|
|
65
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
66
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
67
|
+
) -> ServicingDirectDataUploadFileResponseDTO:
|
|
68
|
+
"""Commit a transaction
|
|
69
|
+
|
|
70
|
+
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.
|
|
71
|
+
|
|
72
|
+
: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)
|
|
73
|
+
:type draft_id: str
|
|
74
|
+
:param transaction_id: The unique identifier of the transaction. (required)
|
|
75
|
+
:type transaction_id: str
|
|
76
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
77
|
+
:type target_tenant_id: str
|
|
78
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
79
|
+
number provided, it will be total request
|
|
80
|
+
timeout. It can also be a pair (tuple) of
|
|
81
|
+
(connection, read) timeouts.
|
|
82
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
83
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
84
|
+
request; this effectively ignores the
|
|
85
|
+
authentication in the spec for a single request.
|
|
86
|
+
:type _request_auth: dict, optional
|
|
87
|
+
:param _content_type: force content-type for the request.
|
|
88
|
+
:type _content_type: str, Optional
|
|
89
|
+
:param _headers: set to override the headers for a single
|
|
90
|
+
request; this effectively ignores the headers
|
|
91
|
+
in the spec for a single request.
|
|
92
|
+
:type _headers: dict, optional
|
|
93
|
+
:param _host_index: set to override the host_index for a single
|
|
94
|
+
request; this effectively ignores the host_index
|
|
95
|
+
in the spec for a single request.
|
|
96
|
+
:type _host_index: int, optional
|
|
97
|
+
:return: Returns the result object.
|
|
98
|
+
""" # noqa: E501
|
|
99
|
+
|
|
100
|
+
_param = self._commit_transaction_serialize(
|
|
101
|
+
draft_id=draft_id,
|
|
102
|
+
transaction_id=transaction_id,
|
|
103
|
+
target_tenant_id=target_tenant_id,
|
|
104
|
+
_request_auth=_request_auth,
|
|
105
|
+
_content_type=_content_type,
|
|
106
|
+
_headers=_headers,
|
|
107
|
+
_host_index=_host_index
|
|
108
|
+
)
|
|
109
|
+
|
|
110
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
111
|
+
'200': "ServicingDirectDataUploadFileResponseDTO",
|
|
112
|
+
}
|
|
113
|
+
response_data = self.api_client.call_api(
|
|
114
|
+
*_param,
|
|
115
|
+
_request_timeout=_request_timeout
|
|
116
|
+
)
|
|
117
|
+
response_data.read()
|
|
118
|
+
return self.api_client.response_deserialize(
|
|
119
|
+
response_data=response_data,
|
|
120
|
+
response_types_map=_response_types_map,
|
|
121
|
+
).data
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
@validate_call
|
|
125
|
+
def commit_transaction_with_http_info(
|
|
126
|
+
self,
|
|
127
|
+
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.")],
|
|
128
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")],
|
|
129
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
130
|
+
_request_timeout: Union[
|
|
131
|
+
None,
|
|
132
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
133
|
+
Tuple[
|
|
134
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
135
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
136
|
+
]
|
|
137
|
+
] = None,
|
|
138
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
139
|
+
_content_type: Optional[StrictStr] = None,
|
|
140
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
141
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
142
|
+
) -> ApiResponse[ServicingDirectDataUploadFileResponseDTO]:
|
|
143
|
+
"""Commit a transaction
|
|
144
|
+
|
|
145
|
+
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.
|
|
146
|
+
|
|
147
|
+
: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)
|
|
148
|
+
:type draft_id: str
|
|
149
|
+
:param transaction_id: The unique identifier of the transaction. (required)
|
|
150
|
+
:type transaction_id: str
|
|
151
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
152
|
+
:type target_tenant_id: str
|
|
153
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
154
|
+
number provided, it will be total request
|
|
155
|
+
timeout. It can also be a pair (tuple) of
|
|
156
|
+
(connection, read) timeouts.
|
|
157
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
158
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
159
|
+
request; this effectively ignores the
|
|
160
|
+
authentication in the spec for a single request.
|
|
161
|
+
:type _request_auth: dict, optional
|
|
162
|
+
:param _content_type: force content-type for the request.
|
|
163
|
+
:type _content_type: str, Optional
|
|
164
|
+
:param _headers: set to override the headers for a single
|
|
165
|
+
request; this effectively ignores the headers
|
|
166
|
+
in the spec for a single request.
|
|
167
|
+
:type _headers: dict, optional
|
|
168
|
+
:param _host_index: set to override the host_index for a single
|
|
169
|
+
request; this effectively ignores the host_index
|
|
170
|
+
in the spec for a single request.
|
|
171
|
+
:type _host_index: int, optional
|
|
172
|
+
:return: Returns the result object.
|
|
173
|
+
""" # noqa: E501
|
|
174
|
+
|
|
175
|
+
_param = self._commit_transaction_serialize(
|
|
176
|
+
draft_id=draft_id,
|
|
177
|
+
transaction_id=transaction_id,
|
|
178
|
+
target_tenant_id=target_tenant_id,
|
|
179
|
+
_request_auth=_request_auth,
|
|
180
|
+
_content_type=_content_type,
|
|
181
|
+
_headers=_headers,
|
|
182
|
+
_host_index=_host_index
|
|
183
|
+
)
|
|
184
|
+
|
|
185
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
186
|
+
'200': "ServicingDirectDataUploadFileResponseDTO",
|
|
187
|
+
}
|
|
188
|
+
response_data = self.api_client.call_api(
|
|
189
|
+
*_param,
|
|
190
|
+
_request_timeout=_request_timeout
|
|
191
|
+
)
|
|
192
|
+
response_data.read()
|
|
193
|
+
return self.api_client.response_deserialize(
|
|
194
|
+
response_data=response_data,
|
|
195
|
+
response_types_map=_response_types_map,
|
|
196
|
+
)
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
@validate_call
|
|
200
|
+
def commit_transaction_without_preload_content(
|
|
201
|
+
self,
|
|
202
|
+
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.")],
|
|
203
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")],
|
|
204
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
205
|
+
_request_timeout: Union[
|
|
206
|
+
None,
|
|
207
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
208
|
+
Tuple[
|
|
209
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
210
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
211
|
+
]
|
|
212
|
+
] = None,
|
|
213
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
214
|
+
_content_type: Optional[StrictStr] = None,
|
|
215
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
216
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
217
|
+
) -> RESTResponseType:
|
|
218
|
+
"""Commit a transaction
|
|
219
|
+
|
|
220
|
+
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.
|
|
221
|
+
|
|
222
|
+
: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)
|
|
223
|
+
:type draft_id: str
|
|
224
|
+
:param transaction_id: The unique identifier of the transaction. (required)
|
|
225
|
+
:type transaction_id: str
|
|
226
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
227
|
+
:type target_tenant_id: str
|
|
228
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
229
|
+
number provided, it will be total request
|
|
230
|
+
timeout. It can also be a pair (tuple) of
|
|
231
|
+
(connection, read) timeouts.
|
|
232
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
233
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
234
|
+
request; this effectively ignores the
|
|
235
|
+
authentication in the spec for a single request.
|
|
236
|
+
:type _request_auth: dict, optional
|
|
237
|
+
:param _content_type: force content-type for the request.
|
|
238
|
+
:type _content_type: str, Optional
|
|
239
|
+
:param _headers: set to override the headers for a single
|
|
240
|
+
request; this effectively ignores the headers
|
|
241
|
+
in the spec for a single request.
|
|
242
|
+
:type _headers: dict, optional
|
|
243
|
+
:param _host_index: set to override the host_index for a single
|
|
244
|
+
request; this effectively ignores the host_index
|
|
245
|
+
in the spec for a single request.
|
|
246
|
+
:type _host_index: int, optional
|
|
247
|
+
:return: Returns the result object.
|
|
248
|
+
""" # noqa: E501
|
|
249
|
+
|
|
250
|
+
_param = self._commit_transaction_serialize(
|
|
251
|
+
draft_id=draft_id,
|
|
252
|
+
transaction_id=transaction_id,
|
|
253
|
+
target_tenant_id=target_tenant_id,
|
|
254
|
+
_request_auth=_request_auth,
|
|
255
|
+
_content_type=_content_type,
|
|
256
|
+
_headers=_headers,
|
|
257
|
+
_host_index=_host_index
|
|
258
|
+
)
|
|
259
|
+
|
|
260
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
261
|
+
'200': "ServicingDirectDataUploadFileResponseDTO",
|
|
262
|
+
}
|
|
263
|
+
response_data = self.api_client.call_api(
|
|
264
|
+
*_param,
|
|
265
|
+
_request_timeout=_request_timeout
|
|
266
|
+
)
|
|
267
|
+
return response_data.response
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
def _commit_transaction_serialize(
|
|
271
|
+
self,
|
|
272
|
+
draft_id,
|
|
273
|
+
transaction_id,
|
|
274
|
+
target_tenant_id,
|
|
275
|
+
_request_auth,
|
|
276
|
+
_content_type,
|
|
277
|
+
_headers,
|
|
278
|
+
_host_index,
|
|
279
|
+
) -> RequestSerialized:
|
|
280
|
+
|
|
281
|
+
_host = None
|
|
282
|
+
|
|
283
|
+
_collection_formats: Dict[str, str] = {
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
_path_params: Dict[str, str] = {}
|
|
287
|
+
_query_params: List[Tuple[str, str]] = []
|
|
288
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
289
|
+
_form_params: List[Tuple[str, str]] = []
|
|
290
|
+
_files: Dict[
|
|
291
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
292
|
+
] = {}
|
|
293
|
+
_body_params: Optional[bytes] = None
|
|
294
|
+
|
|
295
|
+
# process the path parameters
|
|
296
|
+
if draft_id is not None:
|
|
297
|
+
_path_params['draftId'] = draft_id
|
|
298
|
+
if transaction_id is not None:
|
|
299
|
+
_path_params['transactionId'] = transaction_id
|
|
300
|
+
# process the query parameters
|
|
301
|
+
# process the header parameters
|
|
302
|
+
if target_tenant_id is not None:
|
|
303
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
304
|
+
# process the form parameters
|
|
305
|
+
# process the body parameter
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
# set the HTTP header `Accept`
|
|
309
|
+
if 'Accept' not in _header_params:
|
|
310
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
311
|
+
[
|
|
312
|
+
'application/json'
|
|
313
|
+
]
|
|
314
|
+
)
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
# authentication setting
|
|
318
|
+
_auth_settings: List[str] = [
|
|
319
|
+
'CookieAuth',
|
|
320
|
+
'ApiKeyAuth',
|
|
321
|
+
'OAuth2Auth',
|
|
322
|
+
'OAuth2Auth',
|
|
323
|
+
'BearerAuth'
|
|
324
|
+
]
|
|
325
|
+
|
|
326
|
+
return self.api_client.param_serialize(
|
|
327
|
+
method='POST',
|
|
328
|
+
resource_path='/v1/data/directloads/{draftId}/transactions/{transactionId}',
|
|
329
|
+
path_params=_path_params,
|
|
330
|
+
query_params=_query_params,
|
|
331
|
+
header_params=_header_params,
|
|
332
|
+
body=_body_params,
|
|
333
|
+
post_params=_form_params,
|
|
334
|
+
files=_files,
|
|
335
|
+
auth_settings=_auth_settings,
|
|
336
|
+
collection_formats=_collection_formats,
|
|
337
|
+
_host=_host,
|
|
338
|
+
_request_auth=_request_auth
|
|
339
|
+
)
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
@validate_call
|
|
345
|
+
def get_config(
|
|
346
|
+
self,
|
|
347
|
+
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.")],
|
|
348
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
349
|
+
_request_timeout: Union[
|
|
350
|
+
None,
|
|
351
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
352
|
+
Tuple[
|
|
353
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
354
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
355
|
+
]
|
|
356
|
+
] = None,
|
|
357
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
358
|
+
_content_type: Optional[StrictStr] = None,
|
|
359
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
360
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
361
|
+
) -> DirectDataLoadConfigDTO:
|
|
362
|
+
"""Get the direct data intake configuration
|
|
363
|
+
|
|
364
|
+
Get the direct data intake configuration.
|
|
365
|
+
|
|
366
|
+
: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)
|
|
367
|
+
:type draft_id: str
|
|
368
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
369
|
+
:type target_tenant_id: str
|
|
370
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
371
|
+
number provided, it will be total request
|
|
372
|
+
timeout. It can also be a pair (tuple) of
|
|
373
|
+
(connection, read) timeouts.
|
|
374
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
375
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
376
|
+
request; this effectively ignores the
|
|
377
|
+
authentication in the spec for a single request.
|
|
378
|
+
:type _request_auth: dict, optional
|
|
379
|
+
:param _content_type: force content-type for the request.
|
|
380
|
+
:type _content_type: str, Optional
|
|
381
|
+
:param _headers: set to override the headers for a single
|
|
382
|
+
request; this effectively ignores the headers
|
|
383
|
+
in the spec for a single request.
|
|
384
|
+
:type _headers: dict, optional
|
|
385
|
+
:param _host_index: set to override the host_index for a single
|
|
386
|
+
request; this effectively ignores the host_index
|
|
387
|
+
in the spec for a single request.
|
|
388
|
+
:type _host_index: int, optional
|
|
389
|
+
:return: Returns the result object.
|
|
390
|
+
""" # noqa: E501
|
|
391
|
+
|
|
392
|
+
_param = self._get_config_serialize(
|
|
393
|
+
draft_id=draft_id,
|
|
394
|
+
target_tenant_id=target_tenant_id,
|
|
395
|
+
_request_auth=_request_auth,
|
|
396
|
+
_content_type=_content_type,
|
|
397
|
+
_headers=_headers,
|
|
398
|
+
_host_index=_host_index
|
|
399
|
+
)
|
|
400
|
+
|
|
401
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
402
|
+
'200': "DirectDataLoadConfigDTO",
|
|
403
|
+
}
|
|
404
|
+
response_data = self.api_client.call_api(
|
|
405
|
+
*_param,
|
|
406
|
+
_request_timeout=_request_timeout
|
|
407
|
+
)
|
|
408
|
+
response_data.read()
|
|
409
|
+
return self.api_client.response_deserialize(
|
|
410
|
+
response_data=response_data,
|
|
411
|
+
response_types_map=_response_types_map,
|
|
412
|
+
).data
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
@validate_call
|
|
416
|
+
def get_config_with_http_info(
|
|
417
|
+
self,
|
|
418
|
+
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.")],
|
|
419
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
420
|
+
_request_timeout: Union[
|
|
421
|
+
None,
|
|
422
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
423
|
+
Tuple[
|
|
424
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
425
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
426
|
+
]
|
|
427
|
+
] = None,
|
|
428
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
429
|
+
_content_type: Optional[StrictStr] = None,
|
|
430
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
431
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
432
|
+
) -> ApiResponse[DirectDataLoadConfigDTO]:
|
|
433
|
+
"""Get the direct data intake configuration
|
|
434
|
+
|
|
435
|
+
Get the direct data intake configuration.
|
|
436
|
+
|
|
437
|
+
: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)
|
|
438
|
+
:type draft_id: str
|
|
439
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
440
|
+
:type target_tenant_id: str
|
|
441
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
442
|
+
number provided, it will be total request
|
|
443
|
+
timeout. It can also be a pair (tuple) of
|
|
444
|
+
(connection, read) timeouts.
|
|
445
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
446
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
447
|
+
request; this effectively ignores the
|
|
448
|
+
authentication in the spec for a single request.
|
|
449
|
+
:type _request_auth: dict, optional
|
|
450
|
+
:param _content_type: force content-type for the request.
|
|
451
|
+
:type _content_type: str, Optional
|
|
452
|
+
:param _headers: set to override the headers for a single
|
|
453
|
+
request; this effectively ignores the headers
|
|
454
|
+
in the spec for a single request.
|
|
455
|
+
:type _headers: dict, optional
|
|
456
|
+
:param _host_index: set to override the host_index for a single
|
|
457
|
+
request; this effectively ignores the host_index
|
|
458
|
+
in the spec for a single request.
|
|
459
|
+
:type _host_index: int, optional
|
|
460
|
+
:return: Returns the result object.
|
|
461
|
+
""" # noqa: E501
|
|
462
|
+
|
|
463
|
+
_param = self._get_config_serialize(
|
|
464
|
+
draft_id=draft_id,
|
|
465
|
+
target_tenant_id=target_tenant_id,
|
|
466
|
+
_request_auth=_request_auth,
|
|
467
|
+
_content_type=_content_type,
|
|
468
|
+
_headers=_headers,
|
|
469
|
+
_host_index=_host_index
|
|
470
|
+
)
|
|
471
|
+
|
|
472
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
473
|
+
'200': "DirectDataLoadConfigDTO",
|
|
474
|
+
}
|
|
475
|
+
response_data = self.api_client.call_api(
|
|
476
|
+
*_param,
|
|
477
|
+
_request_timeout=_request_timeout
|
|
478
|
+
)
|
|
479
|
+
response_data.read()
|
|
480
|
+
return self.api_client.response_deserialize(
|
|
481
|
+
response_data=response_data,
|
|
482
|
+
response_types_map=_response_types_map,
|
|
483
|
+
)
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
@validate_call
|
|
487
|
+
def get_config_without_preload_content(
|
|
488
|
+
self,
|
|
489
|
+
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.")],
|
|
490
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
491
|
+
_request_timeout: Union[
|
|
492
|
+
None,
|
|
493
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
494
|
+
Tuple[
|
|
495
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
496
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
497
|
+
]
|
|
498
|
+
] = None,
|
|
499
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
500
|
+
_content_type: Optional[StrictStr] = None,
|
|
501
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
502
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
503
|
+
) -> RESTResponseType:
|
|
504
|
+
"""Get the direct data intake configuration
|
|
505
|
+
|
|
506
|
+
Get the direct data intake configuration.
|
|
507
|
+
|
|
508
|
+
: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)
|
|
509
|
+
:type draft_id: str
|
|
510
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
511
|
+
:type target_tenant_id: str
|
|
512
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
513
|
+
number provided, it will be total request
|
|
514
|
+
timeout. It can also be a pair (tuple) of
|
|
515
|
+
(connection, read) timeouts.
|
|
516
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
517
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
518
|
+
request; this effectively ignores the
|
|
519
|
+
authentication in the spec for a single request.
|
|
520
|
+
:type _request_auth: dict, optional
|
|
521
|
+
:param _content_type: force content-type for the request.
|
|
522
|
+
:type _content_type: str, Optional
|
|
523
|
+
:param _headers: set to override the headers for a single
|
|
524
|
+
request; this effectively ignores the headers
|
|
525
|
+
in the spec for a single request.
|
|
526
|
+
:type _headers: dict, optional
|
|
527
|
+
:param _host_index: set to override the host_index for a single
|
|
528
|
+
request; this effectively ignores the host_index
|
|
529
|
+
in the spec for a single request.
|
|
530
|
+
:type _host_index: int, optional
|
|
531
|
+
:return: Returns the result object.
|
|
532
|
+
""" # noqa: E501
|
|
533
|
+
|
|
534
|
+
_param = self._get_config_serialize(
|
|
535
|
+
draft_id=draft_id,
|
|
536
|
+
target_tenant_id=target_tenant_id,
|
|
537
|
+
_request_auth=_request_auth,
|
|
538
|
+
_content_type=_content_type,
|
|
539
|
+
_headers=_headers,
|
|
540
|
+
_host_index=_host_index
|
|
541
|
+
)
|
|
542
|
+
|
|
543
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
544
|
+
'200': "DirectDataLoadConfigDTO",
|
|
545
|
+
}
|
|
546
|
+
response_data = self.api_client.call_api(
|
|
547
|
+
*_param,
|
|
548
|
+
_request_timeout=_request_timeout
|
|
549
|
+
)
|
|
550
|
+
return response_data.response
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
def _get_config_serialize(
|
|
554
|
+
self,
|
|
555
|
+
draft_id,
|
|
556
|
+
target_tenant_id,
|
|
557
|
+
_request_auth,
|
|
558
|
+
_content_type,
|
|
559
|
+
_headers,
|
|
560
|
+
_host_index,
|
|
561
|
+
) -> RequestSerialized:
|
|
562
|
+
|
|
563
|
+
_host = None
|
|
564
|
+
|
|
565
|
+
_collection_formats: Dict[str, str] = {
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
_path_params: Dict[str, str] = {}
|
|
569
|
+
_query_params: List[Tuple[str, str]] = []
|
|
570
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
571
|
+
_form_params: List[Tuple[str, str]] = []
|
|
572
|
+
_files: Dict[
|
|
573
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
574
|
+
] = {}
|
|
575
|
+
_body_params: Optional[bytes] = None
|
|
576
|
+
|
|
577
|
+
# process the path parameters
|
|
578
|
+
if draft_id is not None:
|
|
579
|
+
_path_params['draftId'] = draft_id
|
|
580
|
+
# process the query parameters
|
|
581
|
+
# process the header parameters
|
|
582
|
+
if target_tenant_id is not None:
|
|
583
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
584
|
+
# process the form parameters
|
|
585
|
+
# process the body parameter
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
# set the HTTP header `Accept`
|
|
589
|
+
if 'Accept' not in _header_params:
|
|
590
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
591
|
+
[
|
|
592
|
+
'application/json'
|
|
593
|
+
]
|
|
594
|
+
)
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
# authentication setting
|
|
598
|
+
_auth_settings: List[str] = [
|
|
599
|
+
'CookieAuth',
|
|
600
|
+
'ApiKeyAuth',
|
|
601
|
+
'OAuth2Auth',
|
|
602
|
+
'OAuth2Auth',
|
|
603
|
+
'BearerAuth'
|
|
604
|
+
]
|
|
605
|
+
|
|
606
|
+
return self.api_client.param_serialize(
|
|
607
|
+
method='GET',
|
|
608
|
+
resource_path='/v1/data/directloads/{draftId}/configs',
|
|
609
|
+
path_params=_path_params,
|
|
610
|
+
query_params=_query_params,
|
|
611
|
+
header_params=_header_params,
|
|
612
|
+
body=_body_params,
|
|
613
|
+
post_params=_form_params,
|
|
614
|
+
files=_files,
|
|
615
|
+
auth_settings=_auth_settings,
|
|
616
|
+
collection_formats=_collection_formats,
|
|
617
|
+
_host=_host,
|
|
618
|
+
_request_auth=_request_auth
|
|
619
|
+
)
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
@validate_call
|
|
625
|
+
def job_status(
|
|
626
|
+
self,
|
|
627
|
+
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.")],
|
|
628
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")],
|
|
629
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
630
|
+
_request_timeout: Union[
|
|
631
|
+
None,
|
|
632
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
633
|
+
Tuple[
|
|
634
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
635
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
636
|
+
]
|
|
637
|
+
] = None,
|
|
638
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
639
|
+
_content_type: Optional[StrictStr] = None,
|
|
640
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
641
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
642
|
+
) -> DirectDataJobStatusResponseDTO:
|
|
643
|
+
"""Check transaction status
|
|
644
|
+
|
|
645
|
+
Retrieve the status of a committed transaction's processing job.
|
|
646
|
+
|
|
647
|
+
: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)
|
|
648
|
+
:type draft_id: str
|
|
649
|
+
:param transaction_id: The unique identifier of the transaction. (required)
|
|
650
|
+
:type transaction_id: str
|
|
651
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
652
|
+
:type target_tenant_id: str
|
|
653
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
654
|
+
number provided, it will be total request
|
|
655
|
+
timeout. It can also be a pair (tuple) of
|
|
656
|
+
(connection, read) timeouts.
|
|
657
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
658
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
659
|
+
request; this effectively ignores the
|
|
660
|
+
authentication in the spec for a single request.
|
|
661
|
+
:type _request_auth: dict, optional
|
|
662
|
+
:param _content_type: force content-type for the request.
|
|
663
|
+
:type _content_type: str, Optional
|
|
664
|
+
:param _headers: set to override the headers for a single
|
|
665
|
+
request; this effectively ignores the headers
|
|
666
|
+
in the spec for a single request.
|
|
667
|
+
:type _headers: dict, optional
|
|
668
|
+
:param _host_index: set to override the host_index for a single
|
|
669
|
+
request; this effectively ignores the host_index
|
|
670
|
+
in the spec for a single request.
|
|
671
|
+
:type _host_index: int, optional
|
|
672
|
+
:return: Returns the result object.
|
|
673
|
+
""" # noqa: E501
|
|
674
|
+
|
|
675
|
+
_param = self._job_status_serialize(
|
|
676
|
+
draft_id=draft_id,
|
|
677
|
+
transaction_id=transaction_id,
|
|
678
|
+
target_tenant_id=target_tenant_id,
|
|
679
|
+
_request_auth=_request_auth,
|
|
680
|
+
_content_type=_content_type,
|
|
681
|
+
_headers=_headers,
|
|
682
|
+
_host_index=_host_index
|
|
683
|
+
)
|
|
684
|
+
|
|
685
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
686
|
+
'200': "DirectDataJobStatusResponseDTO",
|
|
687
|
+
}
|
|
688
|
+
response_data = self.api_client.call_api(
|
|
689
|
+
*_param,
|
|
690
|
+
_request_timeout=_request_timeout
|
|
691
|
+
)
|
|
692
|
+
response_data.read()
|
|
693
|
+
return self.api_client.response_deserialize(
|
|
694
|
+
response_data=response_data,
|
|
695
|
+
response_types_map=_response_types_map,
|
|
696
|
+
).data
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
@validate_call
|
|
700
|
+
def job_status_with_http_info(
|
|
701
|
+
self,
|
|
702
|
+
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.")],
|
|
703
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")],
|
|
704
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
705
|
+
_request_timeout: Union[
|
|
706
|
+
None,
|
|
707
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
708
|
+
Tuple[
|
|
709
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
710
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
711
|
+
]
|
|
712
|
+
] = None,
|
|
713
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
714
|
+
_content_type: Optional[StrictStr] = None,
|
|
715
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
716
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
717
|
+
) -> ApiResponse[DirectDataJobStatusResponseDTO]:
|
|
718
|
+
"""Check transaction status
|
|
719
|
+
|
|
720
|
+
Retrieve the status of a committed transaction's processing job.
|
|
721
|
+
|
|
722
|
+
: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)
|
|
723
|
+
:type draft_id: str
|
|
724
|
+
:param transaction_id: The unique identifier of the transaction. (required)
|
|
725
|
+
:type transaction_id: str
|
|
726
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
727
|
+
:type target_tenant_id: str
|
|
728
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
729
|
+
number provided, it will be total request
|
|
730
|
+
timeout. It can also be a pair (tuple) of
|
|
731
|
+
(connection, read) timeouts.
|
|
732
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
733
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
734
|
+
request; this effectively ignores the
|
|
735
|
+
authentication in the spec for a single request.
|
|
736
|
+
:type _request_auth: dict, optional
|
|
737
|
+
:param _content_type: force content-type for the request.
|
|
738
|
+
:type _content_type: str, Optional
|
|
739
|
+
:param _headers: set to override the headers for a single
|
|
740
|
+
request; this effectively ignores the headers
|
|
741
|
+
in the spec for a single request.
|
|
742
|
+
:type _headers: dict, optional
|
|
743
|
+
:param _host_index: set to override the host_index for a single
|
|
744
|
+
request; this effectively ignores the host_index
|
|
745
|
+
in the spec for a single request.
|
|
746
|
+
:type _host_index: int, optional
|
|
747
|
+
:return: Returns the result object.
|
|
748
|
+
""" # noqa: E501
|
|
749
|
+
|
|
750
|
+
_param = self._job_status_serialize(
|
|
751
|
+
draft_id=draft_id,
|
|
752
|
+
transaction_id=transaction_id,
|
|
753
|
+
target_tenant_id=target_tenant_id,
|
|
754
|
+
_request_auth=_request_auth,
|
|
755
|
+
_content_type=_content_type,
|
|
756
|
+
_headers=_headers,
|
|
757
|
+
_host_index=_host_index
|
|
758
|
+
)
|
|
759
|
+
|
|
760
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
761
|
+
'200': "DirectDataJobStatusResponseDTO",
|
|
762
|
+
}
|
|
763
|
+
response_data = self.api_client.call_api(
|
|
764
|
+
*_param,
|
|
765
|
+
_request_timeout=_request_timeout
|
|
766
|
+
)
|
|
767
|
+
response_data.read()
|
|
768
|
+
return self.api_client.response_deserialize(
|
|
769
|
+
response_data=response_data,
|
|
770
|
+
response_types_map=_response_types_map,
|
|
771
|
+
)
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
@validate_call
|
|
775
|
+
def job_status_without_preload_content(
|
|
776
|
+
self,
|
|
777
|
+
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.")],
|
|
778
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")],
|
|
779
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
780
|
+
_request_timeout: Union[
|
|
781
|
+
None,
|
|
782
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
783
|
+
Tuple[
|
|
784
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
785
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
786
|
+
]
|
|
787
|
+
] = None,
|
|
788
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
789
|
+
_content_type: Optional[StrictStr] = None,
|
|
790
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
791
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
792
|
+
) -> RESTResponseType:
|
|
793
|
+
"""Check transaction status
|
|
794
|
+
|
|
795
|
+
Retrieve the status of a committed transaction's processing job.
|
|
796
|
+
|
|
797
|
+
: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)
|
|
798
|
+
:type draft_id: str
|
|
799
|
+
:param transaction_id: The unique identifier of the transaction. (required)
|
|
800
|
+
:type transaction_id: str
|
|
801
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
802
|
+
:type target_tenant_id: str
|
|
803
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
804
|
+
number provided, it will be total request
|
|
805
|
+
timeout. It can also be a pair (tuple) of
|
|
806
|
+
(connection, read) timeouts.
|
|
807
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
808
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
809
|
+
request; this effectively ignores the
|
|
810
|
+
authentication in the spec for a single request.
|
|
811
|
+
:type _request_auth: dict, optional
|
|
812
|
+
:param _content_type: force content-type for the request.
|
|
813
|
+
:type _content_type: str, Optional
|
|
814
|
+
:param _headers: set to override the headers for a single
|
|
815
|
+
request; this effectively ignores the headers
|
|
816
|
+
in the spec for a single request.
|
|
817
|
+
:type _headers: dict, optional
|
|
818
|
+
:param _host_index: set to override the host_index for a single
|
|
819
|
+
request; this effectively ignores the host_index
|
|
820
|
+
in the spec for a single request.
|
|
821
|
+
:type _host_index: int, optional
|
|
822
|
+
:return: Returns the result object.
|
|
823
|
+
""" # noqa: E501
|
|
824
|
+
|
|
825
|
+
_param = self._job_status_serialize(
|
|
826
|
+
draft_id=draft_id,
|
|
827
|
+
transaction_id=transaction_id,
|
|
828
|
+
target_tenant_id=target_tenant_id,
|
|
829
|
+
_request_auth=_request_auth,
|
|
830
|
+
_content_type=_content_type,
|
|
831
|
+
_headers=_headers,
|
|
832
|
+
_host_index=_host_index
|
|
833
|
+
)
|
|
834
|
+
|
|
835
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
836
|
+
'200': "DirectDataJobStatusResponseDTO",
|
|
837
|
+
}
|
|
838
|
+
response_data = self.api_client.call_api(
|
|
839
|
+
*_param,
|
|
840
|
+
_request_timeout=_request_timeout
|
|
841
|
+
)
|
|
842
|
+
return response_data.response
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
def _job_status_serialize(
|
|
846
|
+
self,
|
|
847
|
+
draft_id,
|
|
848
|
+
transaction_id,
|
|
849
|
+
target_tenant_id,
|
|
850
|
+
_request_auth,
|
|
851
|
+
_content_type,
|
|
852
|
+
_headers,
|
|
853
|
+
_host_index,
|
|
854
|
+
) -> RequestSerialized:
|
|
855
|
+
|
|
856
|
+
_host = None
|
|
857
|
+
|
|
858
|
+
_collection_formats: Dict[str, str] = {
|
|
859
|
+
}
|
|
860
|
+
|
|
861
|
+
_path_params: Dict[str, str] = {}
|
|
862
|
+
_query_params: List[Tuple[str, str]] = []
|
|
863
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
864
|
+
_form_params: List[Tuple[str, str]] = []
|
|
865
|
+
_files: Dict[
|
|
866
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
867
|
+
] = {}
|
|
868
|
+
_body_params: Optional[bytes] = None
|
|
869
|
+
|
|
870
|
+
# process the path parameters
|
|
871
|
+
if draft_id is not None:
|
|
872
|
+
_path_params['draftId'] = draft_id
|
|
873
|
+
if transaction_id is not None:
|
|
874
|
+
_path_params['transactionId'] = transaction_id
|
|
875
|
+
# process the query parameters
|
|
876
|
+
# process the header parameters
|
|
877
|
+
if target_tenant_id is not None:
|
|
878
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
879
|
+
# process the form parameters
|
|
880
|
+
# process the body parameter
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
# set the HTTP header `Accept`
|
|
884
|
+
if 'Accept' not in _header_params:
|
|
885
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
886
|
+
[
|
|
887
|
+
'application/json'
|
|
888
|
+
]
|
|
889
|
+
)
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
# authentication setting
|
|
893
|
+
_auth_settings: List[str] = [
|
|
894
|
+
'CookieAuth',
|
|
895
|
+
'ApiKeyAuth',
|
|
896
|
+
'OAuth2Auth',
|
|
897
|
+
'OAuth2Auth',
|
|
898
|
+
'BearerAuth'
|
|
899
|
+
]
|
|
900
|
+
|
|
901
|
+
return self.api_client.param_serialize(
|
|
902
|
+
method='GET',
|
|
903
|
+
resource_path='/v1/data/directloads/{draftId}/transactions/{transactionId}',
|
|
904
|
+
path_params=_path_params,
|
|
905
|
+
query_params=_query_params,
|
|
906
|
+
header_params=_header_params,
|
|
907
|
+
body=_body_params,
|
|
908
|
+
post_params=_form_params,
|
|
909
|
+
files=_files,
|
|
910
|
+
auth_settings=_auth_settings,
|
|
911
|
+
collection_formats=_collection_formats,
|
|
912
|
+
_host=_host,
|
|
913
|
+
_request_auth=_request_auth
|
|
914
|
+
)
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
@validate_call
|
|
920
|
+
def list_transactions(
|
|
921
|
+
self,
|
|
922
|
+
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.")],
|
|
923
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
924
|
+
_request_timeout: Union[
|
|
925
|
+
None,
|
|
926
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
927
|
+
Tuple[
|
|
928
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
929
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
930
|
+
]
|
|
931
|
+
] = None,
|
|
932
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
933
|
+
_content_type: Optional[StrictStr] = None,
|
|
934
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
935
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
936
|
+
) -> DirectDataListTransactionsResponseDTO:
|
|
937
|
+
"""Retrieve a list of open transactions
|
|
938
|
+
|
|
939
|
+
Get a list of all open transactions. Doesn't return committed transactions or rolled back transactions.
|
|
940
|
+
|
|
941
|
+
: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)
|
|
942
|
+
:type draft_id: str
|
|
943
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
944
|
+
:type target_tenant_id: str
|
|
945
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
946
|
+
number provided, it will be total request
|
|
947
|
+
timeout. It can also be a pair (tuple) of
|
|
948
|
+
(connection, read) timeouts.
|
|
949
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
950
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
951
|
+
request; this effectively ignores the
|
|
952
|
+
authentication in the spec for a single request.
|
|
953
|
+
:type _request_auth: dict, optional
|
|
954
|
+
:param _content_type: force content-type for the request.
|
|
955
|
+
:type _content_type: str, Optional
|
|
956
|
+
:param _headers: set to override the headers for a single
|
|
957
|
+
request; this effectively ignores the headers
|
|
958
|
+
in the spec for a single request.
|
|
959
|
+
:type _headers: dict, optional
|
|
960
|
+
:param _host_index: set to override the host_index for a single
|
|
961
|
+
request; this effectively ignores the host_index
|
|
962
|
+
in the spec for a single request.
|
|
963
|
+
:type _host_index: int, optional
|
|
964
|
+
:return: Returns the result object.
|
|
965
|
+
""" # noqa: E501
|
|
966
|
+
|
|
967
|
+
_param = self._list_transactions_serialize(
|
|
968
|
+
draft_id=draft_id,
|
|
969
|
+
target_tenant_id=target_tenant_id,
|
|
970
|
+
_request_auth=_request_auth,
|
|
971
|
+
_content_type=_content_type,
|
|
972
|
+
_headers=_headers,
|
|
973
|
+
_host_index=_host_index
|
|
974
|
+
)
|
|
975
|
+
|
|
976
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
977
|
+
'200': "DirectDataListTransactionsResponseDTO",
|
|
978
|
+
}
|
|
979
|
+
response_data = self.api_client.call_api(
|
|
980
|
+
*_param,
|
|
981
|
+
_request_timeout=_request_timeout
|
|
982
|
+
)
|
|
983
|
+
response_data.read()
|
|
984
|
+
return self.api_client.response_deserialize(
|
|
985
|
+
response_data=response_data,
|
|
986
|
+
response_types_map=_response_types_map,
|
|
987
|
+
).data
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
@validate_call
|
|
991
|
+
def list_transactions_with_http_info(
|
|
992
|
+
self,
|
|
993
|
+
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.")],
|
|
994
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
995
|
+
_request_timeout: Union[
|
|
996
|
+
None,
|
|
997
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
998
|
+
Tuple[
|
|
999
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1000
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1001
|
+
]
|
|
1002
|
+
] = None,
|
|
1003
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1004
|
+
_content_type: Optional[StrictStr] = None,
|
|
1005
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1006
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1007
|
+
) -> ApiResponse[DirectDataListTransactionsResponseDTO]:
|
|
1008
|
+
"""Retrieve a list of open transactions
|
|
1009
|
+
|
|
1010
|
+
Get a list of all open transactions. Doesn't return committed transactions or rolled back transactions.
|
|
1011
|
+
|
|
1012
|
+
: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)
|
|
1013
|
+
:type draft_id: str
|
|
1014
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1015
|
+
:type target_tenant_id: str
|
|
1016
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1017
|
+
number provided, it will be total request
|
|
1018
|
+
timeout. It can also be a pair (tuple) of
|
|
1019
|
+
(connection, read) timeouts.
|
|
1020
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1021
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1022
|
+
request; this effectively ignores the
|
|
1023
|
+
authentication in the spec for a single request.
|
|
1024
|
+
:type _request_auth: dict, optional
|
|
1025
|
+
:param _content_type: force content-type for the request.
|
|
1026
|
+
:type _content_type: str, Optional
|
|
1027
|
+
:param _headers: set to override the headers for a single
|
|
1028
|
+
request; this effectively ignores the headers
|
|
1029
|
+
in the spec for a single request.
|
|
1030
|
+
:type _headers: dict, optional
|
|
1031
|
+
:param _host_index: set to override the host_index for a single
|
|
1032
|
+
request; this effectively ignores the host_index
|
|
1033
|
+
in the spec for a single request.
|
|
1034
|
+
:type _host_index: int, optional
|
|
1035
|
+
:return: Returns the result object.
|
|
1036
|
+
""" # noqa: E501
|
|
1037
|
+
|
|
1038
|
+
_param = self._list_transactions_serialize(
|
|
1039
|
+
draft_id=draft_id,
|
|
1040
|
+
target_tenant_id=target_tenant_id,
|
|
1041
|
+
_request_auth=_request_auth,
|
|
1042
|
+
_content_type=_content_type,
|
|
1043
|
+
_headers=_headers,
|
|
1044
|
+
_host_index=_host_index
|
|
1045
|
+
)
|
|
1046
|
+
|
|
1047
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1048
|
+
'200': "DirectDataListTransactionsResponseDTO",
|
|
1049
|
+
}
|
|
1050
|
+
response_data = self.api_client.call_api(
|
|
1051
|
+
*_param,
|
|
1052
|
+
_request_timeout=_request_timeout
|
|
1053
|
+
)
|
|
1054
|
+
response_data.read()
|
|
1055
|
+
return self.api_client.response_deserialize(
|
|
1056
|
+
response_data=response_data,
|
|
1057
|
+
response_types_map=_response_types_map,
|
|
1058
|
+
)
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
@validate_call
|
|
1062
|
+
def list_transactions_without_preload_content(
|
|
1063
|
+
self,
|
|
1064
|
+
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.")],
|
|
1065
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
1066
|
+
_request_timeout: Union[
|
|
1067
|
+
None,
|
|
1068
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1069
|
+
Tuple[
|
|
1070
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1071
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1072
|
+
]
|
|
1073
|
+
] = None,
|
|
1074
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1075
|
+
_content_type: Optional[StrictStr] = None,
|
|
1076
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1077
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1078
|
+
) -> RESTResponseType:
|
|
1079
|
+
"""Retrieve a list of open transactions
|
|
1080
|
+
|
|
1081
|
+
Get a list of all open transactions. Doesn't return committed transactions or rolled back transactions.
|
|
1082
|
+
|
|
1083
|
+
: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)
|
|
1084
|
+
:type draft_id: str
|
|
1085
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1086
|
+
:type target_tenant_id: str
|
|
1087
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1088
|
+
number provided, it will be total request
|
|
1089
|
+
timeout. It can also be a pair (tuple) of
|
|
1090
|
+
(connection, read) timeouts.
|
|
1091
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1092
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1093
|
+
request; this effectively ignores the
|
|
1094
|
+
authentication in the spec for a single request.
|
|
1095
|
+
:type _request_auth: dict, optional
|
|
1096
|
+
:param _content_type: force content-type for the request.
|
|
1097
|
+
:type _content_type: str, Optional
|
|
1098
|
+
:param _headers: set to override the headers for a single
|
|
1099
|
+
request; this effectively ignores the headers
|
|
1100
|
+
in the spec for a single request.
|
|
1101
|
+
:type _headers: dict, optional
|
|
1102
|
+
:param _host_index: set to override the host_index for a single
|
|
1103
|
+
request; this effectively ignores the host_index
|
|
1104
|
+
in the spec for a single request.
|
|
1105
|
+
:type _host_index: int, optional
|
|
1106
|
+
:return: Returns the result object.
|
|
1107
|
+
""" # noqa: E501
|
|
1108
|
+
|
|
1109
|
+
_param = self._list_transactions_serialize(
|
|
1110
|
+
draft_id=draft_id,
|
|
1111
|
+
target_tenant_id=target_tenant_id,
|
|
1112
|
+
_request_auth=_request_auth,
|
|
1113
|
+
_content_type=_content_type,
|
|
1114
|
+
_headers=_headers,
|
|
1115
|
+
_host_index=_host_index
|
|
1116
|
+
)
|
|
1117
|
+
|
|
1118
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1119
|
+
'200': "DirectDataListTransactionsResponseDTO",
|
|
1120
|
+
}
|
|
1121
|
+
response_data = self.api_client.call_api(
|
|
1122
|
+
*_param,
|
|
1123
|
+
_request_timeout=_request_timeout
|
|
1124
|
+
)
|
|
1125
|
+
return response_data.response
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
def _list_transactions_serialize(
|
|
1129
|
+
self,
|
|
1130
|
+
draft_id,
|
|
1131
|
+
target_tenant_id,
|
|
1132
|
+
_request_auth,
|
|
1133
|
+
_content_type,
|
|
1134
|
+
_headers,
|
|
1135
|
+
_host_index,
|
|
1136
|
+
) -> RequestSerialized:
|
|
1137
|
+
|
|
1138
|
+
_host = None
|
|
1139
|
+
|
|
1140
|
+
_collection_formats: Dict[str, str] = {
|
|
1141
|
+
}
|
|
1142
|
+
|
|
1143
|
+
_path_params: Dict[str, str] = {}
|
|
1144
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1145
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1146
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1147
|
+
_files: Dict[
|
|
1148
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1149
|
+
] = {}
|
|
1150
|
+
_body_params: Optional[bytes] = None
|
|
1151
|
+
|
|
1152
|
+
# process the path parameters
|
|
1153
|
+
if draft_id is not None:
|
|
1154
|
+
_path_params['draftId'] = draft_id
|
|
1155
|
+
# process the query parameters
|
|
1156
|
+
# process the header parameters
|
|
1157
|
+
if target_tenant_id is not None:
|
|
1158
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
1159
|
+
# process the form parameters
|
|
1160
|
+
# process the body parameter
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
# set the HTTP header `Accept`
|
|
1164
|
+
if 'Accept' not in _header_params:
|
|
1165
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1166
|
+
[
|
|
1167
|
+
'application/json'
|
|
1168
|
+
]
|
|
1169
|
+
)
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
# authentication setting
|
|
1173
|
+
_auth_settings: List[str] = [
|
|
1174
|
+
'CookieAuth',
|
|
1175
|
+
'ApiKeyAuth',
|
|
1176
|
+
'OAuth2Auth',
|
|
1177
|
+
'OAuth2Auth',
|
|
1178
|
+
'BearerAuth'
|
|
1179
|
+
]
|
|
1180
|
+
|
|
1181
|
+
return self.api_client.param_serialize(
|
|
1182
|
+
method='GET',
|
|
1183
|
+
resource_path='/v1/data/directloads/{draftId}/transactions',
|
|
1184
|
+
path_params=_path_params,
|
|
1185
|
+
query_params=_query_params,
|
|
1186
|
+
header_params=_header_params,
|
|
1187
|
+
body=_body_params,
|
|
1188
|
+
post_params=_form_params,
|
|
1189
|
+
files=_files,
|
|
1190
|
+
auth_settings=_auth_settings,
|
|
1191
|
+
collection_formats=_collection_formats,
|
|
1192
|
+
_host=_host,
|
|
1193
|
+
_request_auth=_request_auth
|
|
1194
|
+
)
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
@validate_call
|
|
1200
|
+
def load_sample_data(
|
|
1201
|
+
self,
|
|
1202
|
+
draft_id: StrictStr,
|
|
1203
|
+
transaction_id: StrictStr,
|
|
1204
|
+
object_name: StrictStr,
|
|
1205
|
+
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,
|
|
1206
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
1207
|
+
_request_timeout: Union[
|
|
1208
|
+
None,
|
|
1209
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1210
|
+
Tuple[
|
|
1211
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1212
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1213
|
+
]
|
|
1214
|
+
] = None,
|
|
1215
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1216
|
+
_content_type: Optional[StrictStr] = None,
|
|
1217
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1218
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1219
|
+
) -> ServicingDirectDataUploadFileResponseDTO:
|
|
1220
|
+
"""Load sample data
|
|
1221
|
+
|
|
1222
|
+
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`.
|
|
1223
|
+
|
|
1224
|
+
:param draft_id: (required)
|
|
1225
|
+
:type draft_id: str
|
|
1226
|
+
:param transaction_id: (required)
|
|
1227
|
+
:type transaction_id: str
|
|
1228
|
+
:param object_name: (required)
|
|
1229
|
+
:type object_name: str
|
|
1230
|
+
: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.
|
|
1231
|
+
:type sample_name: str
|
|
1232
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1233
|
+
:type target_tenant_id: str
|
|
1234
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1235
|
+
number provided, it will be total request
|
|
1236
|
+
timeout. It can also be a pair (tuple) of
|
|
1237
|
+
(connection, read) timeouts.
|
|
1238
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1239
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1240
|
+
request; this effectively ignores the
|
|
1241
|
+
authentication in the spec for a single request.
|
|
1242
|
+
:type _request_auth: dict, optional
|
|
1243
|
+
:param _content_type: force content-type for the request.
|
|
1244
|
+
:type _content_type: str, Optional
|
|
1245
|
+
:param _headers: set to override the headers for a single
|
|
1246
|
+
request; this effectively ignores the headers
|
|
1247
|
+
in the spec for a single request.
|
|
1248
|
+
:type _headers: dict, optional
|
|
1249
|
+
:param _host_index: set to override the host_index for a single
|
|
1250
|
+
request; this effectively ignores the host_index
|
|
1251
|
+
in the spec for a single request.
|
|
1252
|
+
:type _host_index: int, optional
|
|
1253
|
+
:return: Returns the result object.
|
|
1254
|
+
""" # noqa: E501
|
|
1255
|
+
|
|
1256
|
+
_param = self._load_sample_data_serialize(
|
|
1257
|
+
draft_id=draft_id,
|
|
1258
|
+
transaction_id=transaction_id,
|
|
1259
|
+
object_name=object_name,
|
|
1260
|
+
sample_name=sample_name,
|
|
1261
|
+
target_tenant_id=target_tenant_id,
|
|
1262
|
+
_request_auth=_request_auth,
|
|
1263
|
+
_content_type=_content_type,
|
|
1264
|
+
_headers=_headers,
|
|
1265
|
+
_host_index=_host_index
|
|
1266
|
+
)
|
|
1267
|
+
|
|
1268
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1269
|
+
'200': "ServicingDirectDataUploadFileResponseDTO",
|
|
1270
|
+
}
|
|
1271
|
+
response_data = self.api_client.call_api(
|
|
1272
|
+
*_param,
|
|
1273
|
+
_request_timeout=_request_timeout
|
|
1274
|
+
)
|
|
1275
|
+
response_data.read()
|
|
1276
|
+
return self.api_client.response_deserialize(
|
|
1277
|
+
response_data=response_data,
|
|
1278
|
+
response_types_map=_response_types_map,
|
|
1279
|
+
).data
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
@validate_call
|
|
1283
|
+
def load_sample_data_with_http_info(
|
|
1284
|
+
self,
|
|
1285
|
+
draft_id: StrictStr,
|
|
1286
|
+
transaction_id: StrictStr,
|
|
1287
|
+
object_name: StrictStr,
|
|
1288
|
+
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,
|
|
1289
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
1290
|
+
_request_timeout: Union[
|
|
1291
|
+
None,
|
|
1292
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1293
|
+
Tuple[
|
|
1294
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1295
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1296
|
+
]
|
|
1297
|
+
] = None,
|
|
1298
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1299
|
+
_content_type: Optional[StrictStr] = None,
|
|
1300
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1301
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1302
|
+
) -> ApiResponse[ServicingDirectDataUploadFileResponseDTO]:
|
|
1303
|
+
"""Load sample data
|
|
1304
|
+
|
|
1305
|
+
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`.
|
|
1306
|
+
|
|
1307
|
+
:param draft_id: (required)
|
|
1308
|
+
:type draft_id: str
|
|
1309
|
+
:param transaction_id: (required)
|
|
1310
|
+
:type transaction_id: str
|
|
1311
|
+
:param object_name: (required)
|
|
1312
|
+
:type object_name: str
|
|
1313
|
+
: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.
|
|
1314
|
+
:type sample_name: str
|
|
1315
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1316
|
+
:type target_tenant_id: str
|
|
1317
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1318
|
+
number provided, it will be total request
|
|
1319
|
+
timeout. It can also be a pair (tuple) of
|
|
1320
|
+
(connection, read) timeouts.
|
|
1321
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1322
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1323
|
+
request; this effectively ignores the
|
|
1324
|
+
authentication in the spec for a single request.
|
|
1325
|
+
:type _request_auth: dict, optional
|
|
1326
|
+
:param _content_type: force content-type for the request.
|
|
1327
|
+
:type _content_type: str, Optional
|
|
1328
|
+
:param _headers: set to override the headers for a single
|
|
1329
|
+
request; this effectively ignores the headers
|
|
1330
|
+
in the spec for a single request.
|
|
1331
|
+
:type _headers: dict, optional
|
|
1332
|
+
:param _host_index: set to override the host_index for a single
|
|
1333
|
+
request; this effectively ignores the host_index
|
|
1334
|
+
in the spec for a single request.
|
|
1335
|
+
:type _host_index: int, optional
|
|
1336
|
+
:return: Returns the result object.
|
|
1337
|
+
""" # noqa: E501
|
|
1338
|
+
|
|
1339
|
+
_param = self._load_sample_data_serialize(
|
|
1340
|
+
draft_id=draft_id,
|
|
1341
|
+
transaction_id=transaction_id,
|
|
1342
|
+
object_name=object_name,
|
|
1343
|
+
sample_name=sample_name,
|
|
1344
|
+
target_tenant_id=target_tenant_id,
|
|
1345
|
+
_request_auth=_request_auth,
|
|
1346
|
+
_content_type=_content_type,
|
|
1347
|
+
_headers=_headers,
|
|
1348
|
+
_host_index=_host_index
|
|
1349
|
+
)
|
|
1350
|
+
|
|
1351
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1352
|
+
'200': "ServicingDirectDataUploadFileResponseDTO",
|
|
1353
|
+
}
|
|
1354
|
+
response_data = self.api_client.call_api(
|
|
1355
|
+
*_param,
|
|
1356
|
+
_request_timeout=_request_timeout
|
|
1357
|
+
)
|
|
1358
|
+
response_data.read()
|
|
1359
|
+
return self.api_client.response_deserialize(
|
|
1360
|
+
response_data=response_data,
|
|
1361
|
+
response_types_map=_response_types_map,
|
|
1362
|
+
)
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
@validate_call
|
|
1366
|
+
def load_sample_data_without_preload_content(
|
|
1367
|
+
self,
|
|
1368
|
+
draft_id: StrictStr,
|
|
1369
|
+
transaction_id: StrictStr,
|
|
1370
|
+
object_name: StrictStr,
|
|
1371
|
+
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,
|
|
1372
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
1373
|
+
_request_timeout: Union[
|
|
1374
|
+
None,
|
|
1375
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1376
|
+
Tuple[
|
|
1377
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1378
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1379
|
+
]
|
|
1380
|
+
] = None,
|
|
1381
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1382
|
+
_content_type: Optional[StrictStr] = None,
|
|
1383
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1384
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1385
|
+
) -> RESTResponseType:
|
|
1386
|
+
"""Load sample data
|
|
1387
|
+
|
|
1388
|
+
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`.
|
|
1389
|
+
|
|
1390
|
+
:param draft_id: (required)
|
|
1391
|
+
:type draft_id: str
|
|
1392
|
+
:param transaction_id: (required)
|
|
1393
|
+
:type transaction_id: str
|
|
1394
|
+
:param object_name: (required)
|
|
1395
|
+
:type object_name: str
|
|
1396
|
+
: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.
|
|
1397
|
+
:type sample_name: str
|
|
1398
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1399
|
+
:type target_tenant_id: str
|
|
1400
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1401
|
+
number provided, it will be total request
|
|
1402
|
+
timeout. It can also be a pair (tuple) of
|
|
1403
|
+
(connection, read) timeouts.
|
|
1404
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1405
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1406
|
+
request; this effectively ignores the
|
|
1407
|
+
authentication in the spec for a single request.
|
|
1408
|
+
:type _request_auth: dict, optional
|
|
1409
|
+
:param _content_type: force content-type for the request.
|
|
1410
|
+
:type _content_type: str, Optional
|
|
1411
|
+
:param _headers: set to override the headers for a single
|
|
1412
|
+
request; this effectively ignores the headers
|
|
1413
|
+
in the spec for a single request.
|
|
1414
|
+
:type _headers: dict, optional
|
|
1415
|
+
:param _host_index: set to override the host_index for a single
|
|
1416
|
+
request; this effectively ignores the host_index
|
|
1417
|
+
in the spec for a single request.
|
|
1418
|
+
:type _host_index: int, optional
|
|
1419
|
+
:return: Returns the result object.
|
|
1420
|
+
""" # noqa: E501
|
|
1421
|
+
|
|
1422
|
+
_param = self._load_sample_data_serialize(
|
|
1423
|
+
draft_id=draft_id,
|
|
1424
|
+
transaction_id=transaction_id,
|
|
1425
|
+
object_name=object_name,
|
|
1426
|
+
sample_name=sample_name,
|
|
1427
|
+
target_tenant_id=target_tenant_id,
|
|
1428
|
+
_request_auth=_request_auth,
|
|
1429
|
+
_content_type=_content_type,
|
|
1430
|
+
_headers=_headers,
|
|
1431
|
+
_host_index=_host_index
|
|
1432
|
+
)
|
|
1433
|
+
|
|
1434
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1435
|
+
'200': "ServicingDirectDataUploadFileResponseDTO",
|
|
1436
|
+
}
|
|
1437
|
+
response_data = self.api_client.call_api(
|
|
1438
|
+
*_param,
|
|
1439
|
+
_request_timeout=_request_timeout
|
|
1440
|
+
)
|
|
1441
|
+
return response_data.response
|
|
1442
|
+
|
|
1443
|
+
|
|
1444
|
+
def _load_sample_data_serialize(
|
|
1445
|
+
self,
|
|
1446
|
+
draft_id,
|
|
1447
|
+
transaction_id,
|
|
1448
|
+
object_name,
|
|
1449
|
+
sample_name,
|
|
1450
|
+
target_tenant_id,
|
|
1451
|
+
_request_auth,
|
|
1452
|
+
_content_type,
|
|
1453
|
+
_headers,
|
|
1454
|
+
_host_index,
|
|
1455
|
+
) -> RequestSerialized:
|
|
1456
|
+
|
|
1457
|
+
_host = None
|
|
1458
|
+
|
|
1459
|
+
_collection_formats: Dict[str, str] = {
|
|
1460
|
+
}
|
|
1461
|
+
|
|
1462
|
+
_path_params: Dict[str, str] = {}
|
|
1463
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1464
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1465
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1466
|
+
_files: Dict[
|
|
1467
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1468
|
+
] = {}
|
|
1469
|
+
_body_params: Optional[bytes] = None
|
|
1470
|
+
|
|
1471
|
+
# process the path parameters
|
|
1472
|
+
if draft_id is not None:
|
|
1473
|
+
_path_params['draftId'] = draft_id
|
|
1474
|
+
if transaction_id is not None:
|
|
1475
|
+
_path_params['transactionId'] = transaction_id
|
|
1476
|
+
if object_name is not None:
|
|
1477
|
+
_path_params['objectName'] = object_name
|
|
1478
|
+
# process the query parameters
|
|
1479
|
+
if sample_name is not None:
|
|
1480
|
+
|
|
1481
|
+
_query_params.append(('sampleName', sample_name))
|
|
1482
|
+
|
|
1483
|
+
# process the header parameters
|
|
1484
|
+
if target_tenant_id is not None:
|
|
1485
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
1486
|
+
# process the form parameters
|
|
1487
|
+
# process the body parameter
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
# set the HTTP header `Accept`
|
|
1491
|
+
if 'Accept' not in _header_params:
|
|
1492
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1493
|
+
[
|
|
1494
|
+
'application/json'
|
|
1495
|
+
]
|
|
1496
|
+
)
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
# authentication setting
|
|
1500
|
+
_auth_settings: List[str] = [
|
|
1501
|
+
'CookieAuth',
|
|
1502
|
+
'ApiKeyAuth',
|
|
1503
|
+
'OAuth2Auth',
|
|
1504
|
+
'OAuth2Auth',
|
|
1505
|
+
'BearerAuth'
|
|
1506
|
+
]
|
|
1507
|
+
|
|
1508
|
+
return self.api_client.param_serialize(
|
|
1509
|
+
method='POST',
|
|
1510
|
+
resource_path='/v1/data/directloads/{draftId}/transactions/{transactionId}/{objectName}/sample-data',
|
|
1511
|
+
path_params=_path_params,
|
|
1512
|
+
query_params=_query_params,
|
|
1513
|
+
header_params=_header_params,
|
|
1514
|
+
body=_body_params,
|
|
1515
|
+
post_params=_form_params,
|
|
1516
|
+
files=_files,
|
|
1517
|
+
auth_settings=_auth_settings,
|
|
1518
|
+
collection_formats=_collection_formats,
|
|
1519
|
+
_host=_host,
|
|
1520
|
+
_request_auth=_request_auth
|
|
1521
|
+
)
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
|
|
1526
|
+
@validate_call
|
|
1527
|
+
def object_schema(
|
|
1528
|
+
self,
|
|
1529
|
+
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.")],
|
|
1530
|
+
object_name: Annotated[StrictStr, Field(description="The name of the object to return the load schema for.")],
|
|
1531
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
1532
|
+
_request_timeout: Union[
|
|
1533
|
+
None,
|
|
1534
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1535
|
+
Tuple[
|
|
1536
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1537
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1538
|
+
]
|
|
1539
|
+
] = None,
|
|
1540
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1541
|
+
_content_type: Optional[StrictStr] = None,
|
|
1542
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1543
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1544
|
+
) -> DirectDataSchemaDTO:
|
|
1545
|
+
"""Retrieve an object's data load schema
|
|
1546
|
+
|
|
1547
|
+
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.
|
|
1548
|
+
|
|
1549
|
+
: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)
|
|
1550
|
+
:type draft_id: str
|
|
1551
|
+
:param object_name: The name of the object to return the load schema for. (required)
|
|
1552
|
+
:type object_name: str
|
|
1553
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1554
|
+
:type target_tenant_id: str
|
|
1555
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1556
|
+
number provided, it will be total request
|
|
1557
|
+
timeout. It can also be a pair (tuple) of
|
|
1558
|
+
(connection, read) timeouts.
|
|
1559
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1560
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1561
|
+
request; this effectively ignores the
|
|
1562
|
+
authentication in the spec for a single request.
|
|
1563
|
+
:type _request_auth: dict, optional
|
|
1564
|
+
:param _content_type: force content-type for the request.
|
|
1565
|
+
:type _content_type: str, Optional
|
|
1566
|
+
:param _headers: set to override the headers for a single
|
|
1567
|
+
request; this effectively ignores the headers
|
|
1568
|
+
in the spec for a single request.
|
|
1569
|
+
:type _headers: dict, optional
|
|
1570
|
+
:param _host_index: set to override the host_index for a single
|
|
1571
|
+
request; this effectively ignores the host_index
|
|
1572
|
+
in the spec for a single request.
|
|
1573
|
+
:type _host_index: int, optional
|
|
1574
|
+
:return: Returns the result object.
|
|
1575
|
+
""" # noqa: E501
|
|
1576
|
+
|
|
1577
|
+
_param = self._object_schema_serialize(
|
|
1578
|
+
draft_id=draft_id,
|
|
1579
|
+
object_name=object_name,
|
|
1580
|
+
target_tenant_id=target_tenant_id,
|
|
1581
|
+
_request_auth=_request_auth,
|
|
1582
|
+
_content_type=_content_type,
|
|
1583
|
+
_headers=_headers,
|
|
1584
|
+
_host_index=_host_index
|
|
1585
|
+
)
|
|
1586
|
+
|
|
1587
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1588
|
+
'200': "DirectDataSchemaDTO",
|
|
1589
|
+
}
|
|
1590
|
+
response_data = self.api_client.call_api(
|
|
1591
|
+
*_param,
|
|
1592
|
+
_request_timeout=_request_timeout
|
|
1593
|
+
)
|
|
1594
|
+
response_data.read()
|
|
1595
|
+
return self.api_client.response_deserialize(
|
|
1596
|
+
response_data=response_data,
|
|
1597
|
+
response_types_map=_response_types_map,
|
|
1598
|
+
).data
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
@validate_call
|
|
1602
|
+
def object_schema_with_http_info(
|
|
1603
|
+
self,
|
|
1604
|
+
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.")],
|
|
1605
|
+
object_name: Annotated[StrictStr, Field(description="The name of the object to return the load schema for.")],
|
|
1606
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
1607
|
+
_request_timeout: Union[
|
|
1608
|
+
None,
|
|
1609
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1610
|
+
Tuple[
|
|
1611
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1612
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1613
|
+
]
|
|
1614
|
+
] = None,
|
|
1615
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1616
|
+
_content_type: Optional[StrictStr] = None,
|
|
1617
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1618
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1619
|
+
) -> ApiResponse[DirectDataSchemaDTO]:
|
|
1620
|
+
"""Retrieve an object's data load schema
|
|
1621
|
+
|
|
1622
|
+
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.
|
|
1623
|
+
|
|
1624
|
+
: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)
|
|
1625
|
+
:type draft_id: str
|
|
1626
|
+
:param object_name: The name of the object to return the load schema for. (required)
|
|
1627
|
+
:type object_name: str
|
|
1628
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1629
|
+
:type target_tenant_id: str
|
|
1630
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1631
|
+
number provided, it will be total request
|
|
1632
|
+
timeout. It can also be a pair (tuple) of
|
|
1633
|
+
(connection, read) timeouts.
|
|
1634
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1635
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1636
|
+
request; this effectively ignores the
|
|
1637
|
+
authentication in the spec for a single request.
|
|
1638
|
+
:type _request_auth: dict, optional
|
|
1639
|
+
:param _content_type: force content-type for the request.
|
|
1640
|
+
:type _content_type: str, Optional
|
|
1641
|
+
:param _headers: set to override the headers for a single
|
|
1642
|
+
request; this effectively ignores the headers
|
|
1643
|
+
in the spec for a single request.
|
|
1644
|
+
:type _headers: dict, optional
|
|
1645
|
+
:param _host_index: set to override the host_index for a single
|
|
1646
|
+
request; this effectively ignores the host_index
|
|
1647
|
+
in the spec for a single request.
|
|
1648
|
+
:type _host_index: int, optional
|
|
1649
|
+
:return: Returns the result object.
|
|
1650
|
+
""" # noqa: E501
|
|
1651
|
+
|
|
1652
|
+
_param = self._object_schema_serialize(
|
|
1653
|
+
draft_id=draft_id,
|
|
1654
|
+
object_name=object_name,
|
|
1655
|
+
target_tenant_id=target_tenant_id,
|
|
1656
|
+
_request_auth=_request_auth,
|
|
1657
|
+
_content_type=_content_type,
|
|
1658
|
+
_headers=_headers,
|
|
1659
|
+
_host_index=_host_index
|
|
1660
|
+
)
|
|
1661
|
+
|
|
1662
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1663
|
+
'200': "DirectDataSchemaDTO",
|
|
1664
|
+
}
|
|
1665
|
+
response_data = self.api_client.call_api(
|
|
1666
|
+
*_param,
|
|
1667
|
+
_request_timeout=_request_timeout
|
|
1668
|
+
)
|
|
1669
|
+
response_data.read()
|
|
1670
|
+
return self.api_client.response_deserialize(
|
|
1671
|
+
response_data=response_data,
|
|
1672
|
+
response_types_map=_response_types_map,
|
|
1673
|
+
)
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
@validate_call
|
|
1677
|
+
def object_schema_without_preload_content(
|
|
1678
|
+
self,
|
|
1679
|
+
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.")],
|
|
1680
|
+
object_name: Annotated[StrictStr, Field(description="The name of the object to return the load schema for.")],
|
|
1681
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
1682
|
+
_request_timeout: Union[
|
|
1683
|
+
None,
|
|
1684
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1685
|
+
Tuple[
|
|
1686
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1687
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1688
|
+
]
|
|
1689
|
+
] = None,
|
|
1690
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1691
|
+
_content_type: Optional[StrictStr] = None,
|
|
1692
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1693
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1694
|
+
) -> RESTResponseType:
|
|
1695
|
+
"""Retrieve an object's data load schema
|
|
1696
|
+
|
|
1697
|
+
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.
|
|
1698
|
+
|
|
1699
|
+
: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)
|
|
1700
|
+
:type draft_id: str
|
|
1701
|
+
:param object_name: The name of the object to return the load schema for. (required)
|
|
1702
|
+
:type object_name: str
|
|
1703
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1704
|
+
:type target_tenant_id: str
|
|
1705
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1706
|
+
number provided, it will be total request
|
|
1707
|
+
timeout. It can also be a pair (tuple) of
|
|
1708
|
+
(connection, read) timeouts.
|
|
1709
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1710
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1711
|
+
request; this effectively ignores the
|
|
1712
|
+
authentication in the spec for a single request.
|
|
1713
|
+
:type _request_auth: dict, optional
|
|
1714
|
+
:param _content_type: force content-type for the request.
|
|
1715
|
+
:type _content_type: str, Optional
|
|
1716
|
+
:param _headers: set to override the headers for a single
|
|
1717
|
+
request; this effectively ignores the headers
|
|
1718
|
+
in the spec for a single request.
|
|
1719
|
+
:type _headers: dict, optional
|
|
1720
|
+
:param _host_index: set to override the host_index for a single
|
|
1721
|
+
request; this effectively ignores the host_index
|
|
1722
|
+
in the spec for a single request.
|
|
1723
|
+
:type _host_index: int, optional
|
|
1724
|
+
:return: Returns the result object.
|
|
1725
|
+
""" # noqa: E501
|
|
1726
|
+
|
|
1727
|
+
_param = self._object_schema_serialize(
|
|
1728
|
+
draft_id=draft_id,
|
|
1729
|
+
object_name=object_name,
|
|
1730
|
+
target_tenant_id=target_tenant_id,
|
|
1731
|
+
_request_auth=_request_auth,
|
|
1732
|
+
_content_type=_content_type,
|
|
1733
|
+
_headers=_headers,
|
|
1734
|
+
_host_index=_host_index
|
|
1735
|
+
)
|
|
1736
|
+
|
|
1737
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1738
|
+
'200': "DirectDataSchemaDTO",
|
|
1739
|
+
}
|
|
1740
|
+
response_data = self.api_client.call_api(
|
|
1741
|
+
*_param,
|
|
1742
|
+
_request_timeout=_request_timeout
|
|
1743
|
+
)
|
|
1744
|
+
return response_data.response
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
def _object_schema_serialize(
|
|
1748
|
+
self,
|
|
1749
|
+
draft_id,
|
|
1750
|
+
object_name,
|
|
1751
|
+
target_tenant_id,
|
|
1752
|
+
_request_auth,
|
|
1753
|
+
_content_type,
|
|
1754
|
+
_headers,
|
|
1755
|
+
_host_index,
|
|
1756
|
+
) -> RequestSerialized:
|
|
1757
|
+
|
|
1758
|
+
_host = None
|
|
1759
|
+
|
|
1760
|
+
_collection_formats: Dict[str, str] = {
|
|
1761
|
+
}
|
|
1762
|
+
|
|
1763
|
+
_path_params: Dict[str, str] = {}
|
|
1764
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1765
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1766
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1767
|
+
_files: Dict[
|
|
1768
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1769
|
+
] = {}
|
|
1770
|
+
_body_params: Optional[bytes] = None
|
|
1771
|
+
|
|
1772
|
+
# process the path parameters
|
|
1773
|
+
if draft_id is not None:
|
|
1774
|
+
_path_params['draftId'] = draft_id
|
|
1775
|
+
if object_name is not None:
|
|
1776
|
+
_path_params['objectName'] = object_name
|
|
1777
|
+
# process the query parameters
|
|
1778
|
+
# process the header parameters
|
|
1779
|
+
if target_tenant_id is not None:
|
|
1780
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
1781
|
+
# process the form parameters
|
|
1782
|
+
# process the body parameter
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
# set the HTTP header `Accept`
|
|
1786
|
+
if 'Accept' not in _header_params:
|
|
1787
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1788
|
+
[
|
|
1789
|
+
'application/json'
|
|
1790
|
+
]
|
|
1791
|
+
)
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
# authentication setting
|
|
1795
|
+
_auth_settings: List[str] = [
|
|
1796
|
+
'CookieAuth',
|
|
1797
|
+
'ApiKeyAuth',
|
|
1798
|
+
'OAuth2Auth',
|
|
1799
|
+
'OAuth2Auth',
|
|
1800
|
+
'BearerAuth'
|
|
1801
|
+
]
|
|
1802
|
+
|
|
1803
|
+
return self.api_client.param_serialize(
|
|
1804
|
+
method='GET',
|
|
1805
|
+
resource_path='/v1/data/directloads/{draftId}/schemas/{objectName}',
|
|
1806
|
+
path_params=_path_params,
|
|
1807
|
+
query_params=_query_params,
|
|
1808
|
+
header_params=_header_params,
|
|
1809
|
+
body=_body_params,
|
|
1810
|
+
post_params=_form_params,
|
|
1811
|
+
files=_files,
|
|
1812
|
+
auth_settings=_auth_settings,
|
|
1813
|
+
collection_formats=_collection_formats,
|
|
1814
|
+
_host=_host,
|
|
1815
|
+
_request_auth=_request_auth
|
|
1816
|
+
)
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
@validate_call
|
|
1822
|
+
def put_config(
|
|
1823
|
+
self,
|
|
1824
|
+
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.")],
|
|
1825
|
+
direct_data_load_config_dto: DirectDataLoadConfigDTO,
|
|
1826
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
1827
|
+
_request_timeout: Union[
|
|
1828
|
+
None,
|
|
1829
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1830
|
+
Tuple[
|
|
1831
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1832
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1833
|
+
]
|
|
1834
|
+
] = None,
|
|
1835
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1836
|
+
_content_type: Optional[StrictStr] = None,
|
|
1837
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1838
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1839
|
+
) -> DirectDataLoadConfigDTO:
|
|
1840
|
+
"""Update the direct data intake configuration
|
|
1841
|
+
|
|
1842
|
+
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.
|
|
1843
|
+
|
|
1844
|
+
: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)
|
|
1845
|
+
:type draft_id: str
|
|
1846
|
+
:param direct_data_load_config_dto: (required)
|
|
1847
|
+
:type direct_data_load_config_dto: DirectDataLoadConfigDTO
|
|
1848
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1849
|
+
:type target_tenant_id: str
|
|
1850
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1851
|
+
number provided, it will be total request
|
|
1852
|
+
timeout. It can also be a pair (tuple) of
|
|
1853
|
+
(connection, read) timeouts.
|
|
1854
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1855
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1856
|
+
request; this effectively ignores the
|
|
1857
|
+
authentication in the spec for a single request.
|
|
1858
|
+
:type _request_auth: dict, optional
|
|
1859
|
+
:param _content_type: force content-type for the request.
|
|
1860
|
+
:type _content_type: str, Optional
|
|
1861
|
+
:param _headers: set to override the headers for a single
|
|
1862
|
+
request; this effectively ignores the headers
|
|
1863
|
+
in the spec for a single request.
|
|
1864
|
+
:type _headers: dict, optional
|
|
1865
|
+
:param _host_index: set to override the host_index for a single
|
|
1866
|
+
request; this effectively ignores the host_index
|
|
1867
|
+
in the spec for a single request.
|
|
1868
|
+
:type _host_index: int, optional
|
|
1869
|
+
:return: Returns the result object.
|
|
1870
|
+
""" # noqa: E501
|
|
1871
|
+
|
|
1872
|
+
_param = self._put_config_serialize(
|
|
1873
|
+
draft_id=draft_id,
|
|
1874
|
+
direct_data_load_config_dto=direct_data_load_config_dto,
|
|
1875
|
+
target_tenant_id=target_tenant_id,
|
|
1876
|
+
_request_auth=_request_auth,
|
|
1877
|
+
_content_type=_content_type,
|
|
1878
|
+
_headers=_headers,
|
|
1879
|
+
_host_index=_host_index
|
|
1880
|
+
)
|
|
1881
|
+
|
|
1882
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1883
|
+
'200': "DirectDataLoadConfigDTO",
|
|
1884
|
+
}
|
|
1885
|
+
response_data = self.api_client.call_api(
|
|
1886
|
+
*_param,
|
|
1887
|
+
_request_timeout=_request_timeout
|
|
1888
|
+
)
|
|
1889
|
+
response_data.read()
|
|
1890
|
+
return self.api_client.response_deserialize(
|
|
1891
|
+
response_data=response_data,
|
|
1892
|
+
response_types_map=_response_types_map,
|
|
1893
|
+
).data
|
|
1894
|
+
|
|
1895
|
+
|
|
1896
|
+
@validate_call
|
|
1897
|
+
def put_config_with_http_info(
|
|
1898
|
+
self,
|
|
1899
|
+
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.")],
|
|
1900
|
+
direct_data_load_config_dto: DirectDataLoadConfigDTO,
|
|
1901
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
1902
|
+
_request_timeout: Union[
|
|
1903
|
+
None,
|
|
1904
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1905
|
+
Tuple[
|
|
1906
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1907
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1908
|
+
]
|
|
1909
|
+
] = None,
|
|
1910
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1911
|
+
_content_type: Optional[StrictStr] = None,
|
|
1912
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1913
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1914
|
+
) -> ApiResponse[DirectDataLoadConfigDTO]:
|
|
1915
|
+
"""Update the direct data intake configuration
|
|
1916
|
+
|
|
1917
|
+
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.
|
|
1918
|
+
|
|
1919
|
+
: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)
|
|
1920
|
+
:type draft_id: str
|
|
1921
|
+
:param direct_data_load_config_dto: (required)
|
|
1922
|
+
:type direct_data_load_config_dto: DirectDataLoadConfigDTO
|
|
1923
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1924
|
+
:type target_tenant_id: str
|
|
1925
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1926
|
+
number provided, it will be total request
|
|
1927
|
+
timeout. It can also be a pair (tuple) of
|
|
1928
|
+
(connection, read) timeouts.
|
|
1929
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1930
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1931
|
+
request; this effectively ignores the
|
|
1932
|
+
authentication in the spec for a single request.
|
|
1933
|
+
:type _request_auth: dict, optional
|
|
1934
|
+
:param _content_type: force content-type for the request.
|
|
1935
|
+
:type _content_type: str, Optional
|
|
1936
|
+
:param _headers: set to override the headers for a single
|
|
1937
|
+
request; this effectively ignores the headers
|
|
1938
|
+
in the spec for a single request.
|
|
1939
|
+
:type _headers: dict, optional
|
|
1940
|
+
:param _host_index: set to override the host_index for a single
|
|
1941
|
+
request; this effectively ignores the host_index
|
|
1942
|
+
in the spec for a single request.
|
|
1943
|
+
:type _host_index: int, optional
|
|
1944
|
+
:return: Returns the result object.
|
|
1945
|
+
""" # noqa: E501
|
|
1946
|
+
|
|
1947
|
+
_param = self._put_config_serialize(
|
|
1948
|
+
draft_id=draft_id,
|
|
1949
|
+
direct_data_load_config_dto=direct_data_load_config_dto,
|
|
1950
|
+
target_tenant_id=target_tenant_id,
|
|
1951
|
+
_request_auth=_request_auth,
|
|
1952
|
+
_content_type=_content_type,
|
|
1953
|
+
_headers=_headers,
|
|
1954
|
+
_host_index=_host_index
|
|
1955
|
+
)
|
|
1956
|
+
|
|
1957
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1958
|
+
'200': "DirectDataLoadConfigDTO",
|
|
1959
|
+
}
|
|
1960
|
+
response_data = self.api_client.call_api(
|
|
1961
|
+
*_param,
|
|
1962
|
+
_request_timeout=_request_timeout
|
|
1963
|
+
)
|
|
1964
|
+
response_data.read()
|
|
1965
|
+
return self.api_client.response_deserialize(
|
|
1966
|
+
response_data=response_data,
|
|
1967
|
+
response_types_map=_response_types_map,
|
|
1968
|
+
)
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
@validate_call
|
|
1972
|
+
def put_config_without_preload_content(
|
|
1973
|
+
self,
|
|
1974
|
+
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.")],
|
|
1975
|
+
direct_data_load_config_dto: DirectDataLoadConfigDTO,
|
|
1976
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
1977
|
+
_request_timeout: Union[
|
|
1978
|
+
None,
|
|
1979
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1980
|
+
Tuple[
|
|
1981
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1982
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1983
|
+
]
|
|
1984
|
+
] = None,
|
|
1985
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1986
|
+
_content_type: Optional[StrictStr] = None,
|
|
1987
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1988
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1989
|
+
) -> RESTResponseType:
|
|
1990
|
+
"""Update the direct data intake configuration
|
|
1991
|
+
|
|
1992
|
+
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.
|
|
1993
|
+
|
|
1994
|
+
: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)
|
|
1995
|
+
:type draft_id: str
|
|
1996
|
+
:param direct_data_load_config_dto: (required)
|
|
1997
|
+
:type direct_data_load_config_dto: DirectDataLoadConfigDTO
|
|
1998
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
1999
|
+
:type target_tenant_id: str
|
|
2000
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
2001
|
+
number provided, it will be total request
|
|
2002
|
+
timeout. It can also be a pair (tuple) of
|
|
2003
|
+
(connection, read) timeouts.
|
|
2004
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
2005
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2006
|
+
request; this effectively ignores the
|
|
2007
|
+
authentication in the spec for a single request.
|
|
2008
|
+
:type _request_auth: dict, optional
|
|
2009
|
+
:param _content_type: force content-type for the request.
|
|
2010
|
+
:type _content_type: str, Optional
|
|
2011
|
+
:param _headers: set to override the headers for a single
|
|
2012
|
+
request; this effectively ignores the headers
|
|
2013
|
+
in the spec for a single request.
|
|
2014
|
+
:type _headers: dict, optional
|
|
2015
|
+
:param _host_index: set to override the host_index for a single
|
|
2016
|
+
request; this effectively ignores the host_index
|
|
2017
|
+
in the spec for a single request.
|
|
2018
|
+
:type _host_index: int, optional
|
|
2019
|
+
:return: Returns the result object.
|
|
2020
|
+
""" # noqa: E501
|
|
2021
|
+
|
|
2022
|
+
_param = self._put_config_serialize(
|
|
2023
|
+
draft_id=draft_id,
|
|
2024
|
+
direct_data_load_config_dto=direct_data_load_config_dto,
|
|
2025
|
+
target_tenant_id=target_tenant_id,
|
|
2026
|
+
_request_auth=_request_auth,
|
|
2027
|
+
_content_type=_content_type,
|
|
2028
|
+
_headers=_headers,
|
|
2029
|
+
_host_index=_host_index
|
|
2030
|
+
)
|
|
2031
|
+
|
|
2032
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
2033
|
+
'200': "DirectDataLoadConfigDTO",
|
|
2034
|
+
}
|
|
2035
|
+
response_data = self.api_client.call_api(
|
|
2036
|
+
*_param,
|
|
2037
|
+
_request_timeout=_request_timeout
|
|
2038
|
+
)
|
|
2039
|
+
return response_data.response
|
|
2040
|
+
|
|
2041
|
+
|
|
2042
|
+
def _put_config_serialize(
|
|
2043
|
+
self,
|
|
2044
|
+
draft_id,
|
|
2045
|
+
direct_data_load_config_dto,
|
|
2046
|
+
target_tenant_id,
|
|
2047
|
+
_request_auth,
|
|
2048
|
+
_content_type,
|
|
2049
|
+
_headers,
|
|
2050
|
+
_host_index,
|
|
2051
|
+
) -> RequestSerialized:
|
|
2052
|
+
|
|
2053
|
+
_host = None
|
|
2054
|
+
|
|
2055
|
+
_collection_formats: Dict[str, str] = {
|
|
2056
|
+
}
|
|
2057
|
+
|
|
2058
|
+
_path_params: Dict[str, str] = {}
|
|
2059
|
+
_query_params: List[Tuple[str, str]] = []
|
|
2060
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
2061
|
+
_form_params: List[Tuple[str, str]] = []
|
|
2062
|
+
_files: Dict[
|
|
2063
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
2064
|
+
] = {}
|
|
2065
|
+
_body_params: Optional[bytes] = None
|
|
2066
|
+
|
|
2067
|
+
# process the path parameters
|
|
2068
|
+
if draft_id is not None:
|
|
2069
|
+
_path_params['draftId'] = draft_id
|
|
2070
|
+
# process the query parameters
|
|
2071
|
+
# process the header parameters
|
|
2072
|
+
if target_tenant_id is not None:
|
|
2073
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
2074
|
+
# process the form parameters
|
|
2075
|
+
# process the body parameter
|
|
2076
|
+
if direct_data_load_config_dto is not None:
|
|
2077
|
+
_body_params = direct_data_load_config_dto
|
|
2078
|
+
|
|
2079
|
+
|
|
2080
|
+
# set the HTTP header `Accept`
|
|
2081
|
+
if 'Accept' not in _header_params:
|
|
2082
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
2083
|
+
[
|
|
2084
|
+
'application/json'
|
|
2085
|
+
]
|
|
2086
|
+
)
|
|
2087
|
+
|
|
2088
|
+
# set the HTTP header `Content-Type`
|
|
2089
|
+
if _content_type:
|
|
2090
|
+
_header_params['Content-Type'] = _content_type
|
|
2091
|
+
else:
|
|
2092
|
+
_default_content_type = (
|
|
2093
|
+
self.api_client.select_header_content_type(
|
|
2094
|
+
[
|
|
2095
|
+
'application/json'
|
|
2096
|
+
]
|
|
2097
|
+
)
|
|
2098
|
+
)
|
|
2099
|
+
if _default_content_type is not None:
|
|
2100
|
+
_header_params['Content-Type'] = _default_content_type
|
|
2101
|
+
|
|
2102
|
+
# authentication setting
|
|
2103
|
+
_auth_settings: List[str] = [
|
|
2104
|
+
'CookieAuth',
|
|
2105
|
+
'ApiKeyAuth',
|
|
2106
|
+
'OAuth2Auth',
|
|
2107
|
+
'OAuth2Auth',
|
|
2108
|
+
'BearerAuth'
|
|
2109
|
+
]
|
|
2110
|
+
|
|
2111
|
+
return self.api_client.param_serialize(
|
|
2112
|
+
method='PUT',
|
|
2113
|
+
resource_path='/v1/data/directloads/{draftId}/configs',
|
|
2114
|
+
path_params=_path_params,
|
|
2115
|
+
query_params=_query_params,
|
|
2116
|
+
header_params=_header_params,
|
|
2117
|
+
body=_body_params,
|
|
2118
|
+
post_params=_form_params,
|
|
2119
|
+
files=_files,
|
|
2120
|
+
auth_settings=_auth_settings,
|
|
2121
|
+
collection_formats=_collection_formats,
|
|
2122
|
+
_host=_host,
|
|
2123
|
+
_request_auth=_request_auth
|
|
2124
|
+
)
|
|
2125
|
+
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
@validate_call
|
|
2130
|
+
def rollback_transaction(
|
|
2131
|
+
self,
|
|
2132
|
+
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.")],
|
|
2133
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")],
|
|
2134
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
2135
|
+
_request_timeout: Union[
|
|
2136
|
+
None,
|
|
2137
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2138
|
+
Tuple[
|
|
2139
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2140
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
2141
|
+
]
|
|
2142
|
+
] = None,
|
|
2143
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
2144
|
+
_content_type: Optional[StrictStr] = None,
|
|
2145
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
2146
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
2147
|
+
) -> ServicingDirectDataUploadFileResponseDTO:
|
|
2148
|
+
"""Roll back a transaction
|
|
2149
|
+
|
|
2150
|
+
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.
|
|
2151
|
+
|
|
2152
|
+
: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)
|
|
2153
|
+
:type draft_id: str
|
|
2154
|
+
:param transaction_id: The unique identifier of the transaction. (required)
|
|
2155
|
+
:type transaction_id: str
|
|
2156
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
2157
|
+
:type target_tenant_id: str
|
|
2158
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
2159
|
+
number provided, it will be total request
|
|
2160
|
+
timeout. It can also be a pair (tuple) of
|
|
2161
|
+
(connection, read) timeouts.
|
|
2162
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
2163
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2164
|
+
request; this effectively ignores the
|
|
2165
|
+
authentication in the spec for a single request.
|
|
2166
|
+
:type _request_auth: dict, optional
|
|
2167
|
+
:param _content_type: force content-type for the request.
|
|
2168
|
+
:type _content_type: str, Optional
|
|
2169
|
+
:param _headers: set to override the headers for a single
|
|
2170
|
+
request; this effectively ignores the headers
|
|
2171
|
+
in the spec for a single request.
|
|
2172
|
+
:type _headers: dict, optional
|
|
2173
|
+
:param _host_index: set to override the host_index for a single
|
|
2174
|
+
request; this effectively ignores the host_index
|
|
2175
|
+
in the spec for a single request.
|
|
2176
|
+
:type _host_index: int, optional
|
|
2177
|
+
:return: Returns the result object.
|
|
2178
|
+
""" # noqa: E501
|
|
2179
|
+
|
|
2180
|
+
_param = self._rollback_transaction_serialize(
|
|
2181
|
+
draft_id=draft_id,
|
|
2182
|
+
transaction_id=transaction_id,
|
|
2183
|
+
target_tenant_id=target_tenant_id,
|
|
2184
|
+
_request_auth=_request_auth,
|
|
2185
|
+
_content_type=_content_type,
|
|
2186
|
+
_headers=_headers,
|
|
2187
|
+
_host_index=_host_index
|
|
2188
|
+
)
|
|
2189
|
+
|
|
2190
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
2191
|
+
'200': "ServicingDirectDataUploadFileResponseDTO",
|
|
2192
|
+
}
|
|
2193
|
+
response_data = self.api_client.call_api(
|
|
2194
|
+
*_param,
|
|
2195
|
+
_request_timeout=_request_timeout
|
|
2196
|
+
)
|
|
2197
|
+
response_data.read()
|
|
2198
|
+
return self.api_client.response_deserialize(
|
|
2199
|
+
response_data=response_data,
|
|
2200
|
+
response_types_map=_response_types_map,
|
|
2201
|
+
).data
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
@validate_call
|
|
2205
|
+
def rollback_transaction_with_http_info(
|
|
2206
|
+
self,
|
|
2207
|
+
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.")],
|
|
2208
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")],
|
|
2209
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
2210
|
+
_request_timeout: Union[
|
|
2211
|
+
None,
|
|
2212
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2213
|
+
Tuple[
|
|
2214
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2215
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
2216
|
+
]
|
|
2217
|
+
] = None,
|
|
2218
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
2219
|
+
_content_type: Optional[StrictStr] = None,
|
|
2220
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
2221
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
2222
|
+
) -> ApiResponse[ServicingDirectDataUploadFileResponseDTO]:
|
|
2223
|
+
"""Roll back a transaction
|
|
2224
|
+
|
|
2225
|
+
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.
|
|
2226
|
+
|
|
2227
|
+
: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)
|
|
2228
|
+
:type draft_id: str
|
|
2229
|
+
:param transaction_id: The unique identifier of the transaction. (required)
|
|
2230
|
+
:type transaction_id: str
|
|
2231
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
2232
|
+
:type target_tenant_id: str
|
|
2233
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
2234
|
+
number provided, it will be total request
|
|
2235
|
+
timeout. It can also be a pair (tuple) of
|
|
2236
|
+
(connection, read) timeouts.
|
|
2237
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
2238
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2239
|
+
request; this effectively ignores the
|
|
2240
|
+
authentication in the spec for a single request.
|
|
2241
|
+
:type _request_auth: dict, optional
|
|
2242
|
+
:param _content_type: force content-type for the request.
|
|
2243
|
+
:type _content_type: str, Optional
|
|
2244
|
+
:param _headers: set to override the headers for a single
|
|
2245
|
+
request; this effectively ignores the headers
|
|
2246
|
+
in the spec for a single request.
|
|
2247
|
+
:type _headers: dict, optional
|
|
2248
|
+
:param _host_index: set to override the host_index for a single
|
|
2249
|
+
request; this effectively ignores the host_index
|
|
2250
|
+
in the spec for a single request.
|
|
2251
|
+
:type _host_index: int, optional
|
|
2252
|
+
:return: Returns the result object.
|
|
2253
|
+
""" # noqa: E501
|
|
2254
|
+
|
|
2255
|
+
_param = self._rollback_transaction_serialize(
|
|
2256
|
+
draft_id=draft_id,
|
|
2257
|
+
transaction_id=transaction_id,
|
|
2258
|
+
target_tenant_id=target_tenant_id,
|
|
2259
|
+
_request_auth=_request_auth,
|
|
2260
|
+
_content_type=_content_type,
|
|
2261
|
+
_headers=_headers,
|
|
2262
|
+
_host_index=_host_index
|
|
2263
|
+
)
|
|
2264
|
+
|
|
2265
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
2266
|
+
'200': "ServicingDirectDataUploadFileResponseDTO",
|
|
2267
|
+
}
|
|
2268
|
+
response_data = self.api_client.call_api(
|
|
2269
|
+
*_param,
|
|
2270
|
+
_request_timeout=_request_timeout
|
|
2271
|
+
)
|
|
2272
|
+
response_data.read()
|
|
2273
|
+
return self.api_client.response_deserialize(
|
|
2274
|
+
response_data=response_data,
|
|
2275
|
+
response_types_map=_response_types_map,
|
|
2276
|
+
)
|
|
2277
|
+
|
|
2278
|
+
|
|
2279
|
+
@validate_call
|
|
2280
|
+
def rollback_transaction_without_preload_content(
|
|
2281
|
+
self,
|
|
2282
|
+
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.")],
|
|
2283
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction.")],
|
|
2284
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
2285
|
+
_request_timeout: Union[
|
|
2286
|
+
None,
|
|
2287
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2288
|
+
Tuple[
|
|
2289
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2290
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
2291
|
+
]
|
|
2292
|
+
] = None,
|
|
2293
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
2294
|
+
_content_type: Optional[StrictStr] = None,
|
|
2295
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
2296
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
2297
|
+
) -> RESTResponseType:
|
|
2298
|
+
"""Roll back a transaction
|
|
2299
|
+
|
|
2300
|
+
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.
|
|
2301
|
+
|
|
2302
|
+
: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)
|
|
2303
|
+
:type draft_id: str
|
|
2304
|
+
:param transaction_id: The unique identifier of the transaction. (required)
|
|
2305
|
+
:type transaction_id: str
|
|
2306
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
2307
|
+
:type target_tenant_id: str
|
|
2308
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
2309
|
+
number provided, it will be total request
|
|
2310
|
+
timeout. It can also be a pair (tuple) of
|
|
2311
|
+
(connection, read) timeouts.
|
|
2312
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
2313
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2314
|
+
request; this effectively ignores the
|
|
2315
|
+
authentication in the spec for a single request.
|
|
2316
|
+
:type _request_auth: dict, optional
|
|
2317
|
+
:param _content_type: force content-type for the request.
|
|
2318
|
+
:type _content_type: str, Optional
|
|
2319
|
+
:param _headers: set to override the headers for a single
|
|
2320
|
+
request; this effectively ignores the headers
|
|
2321
|
+
in the spec for a single request.
|
|
2322
|
+
:type _headers: dict, optional
|
|
2323
|
+
:param _host_index: set to override the host_index for a single
|
|
2324
|
+
request; this effectively ignores the host_index
|
|
2325
|
+
in the spec for a single request.
|
|
2326
|
+
:type _host_index: int, optional
|
|
2327
|
+
:return: Returns the result object.
|
|
2328
|
+
""" # noqa: E501
|
|
2329
|
+
|
|
2330
|
+
_param = self._rollback_transaction_serialize(
|
|
2331
|
+
draft_id=draft_id,
|
|
2332
|
+
transaction_id=transaction_id,
|
|
2333
|
+
target_tenant_id=target_tenant_id,
|
|
2334
|
+
_request_auth=_request_auth,
|
|
2335
|
+
_content_type=_content_type,
|
|
2336
|
+
_headers=_headers,
|
|
2337
|
+
_host_index=_host_index
|
|
2338
|
+
)
|
|
2339
|
+
|
|
2340
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
2341
|
+
'200': "ServicingDirectDataUploadFileResponseDTO",
|
|
2342
|
+
}
|
|
2343
|
+
response_data = self.api_client.call_api(
|
|
2344
|
+
*_param,
|
|
2345
|
+
_request_timeout=_request_timeout
|
|
2346
|
+
)
|
|
2347
|
+
return response_data.response
|
|
2348
|
+
|
|
2349
|
+
|
|
2350
|
+
def _rollback_transaction_serialize(
|
|
2351
|
+
self,
|
|
2352
|
+
draft_id,
|
|
2353
|
+
transaction_id,
|
|
2354
|
+
target_tenant_id,
|
|
2355
|
+
_request_auth,
|
|
2356
|
+
_content_type,
|
|
2357
|
+
_headers,
|
|
2358
|
+
_host_index,
|
|
2359
|
+
) -> RequestSerialized:
|
|
2360
|
+
|
|
2361
|
+
_host = None
|
|
2362
|
+
|
|
2363
|
+
_collection_formats: Dict[str, str] = {
|
|
2364
|
+
}
|
|
2365
|
+
|
|
2366
|
+
_path_params: Dict[str, str] = {}
|
|
2367
|
+
_query_params: List[Tuple[str, str]] = []
|
|
2368
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
2369
|
+
_form_params: List[Tuple[str, str]] = []
|
|
2370
|
+
_files: Dict[
|
|
2371
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
2372
|
+
] = {}
|
|
2373
|
+
_body_params: Optional[bytes] = None
|
|
2374
|
+
|
|
2375
|
+
# process the path parameters
|
|
2376
|
+
if draft_id is not None:
|
|
2377
|
+
_path_params['draftId'] = draft_id
|
|
2378
|
+
if transaction_id is not None:
|
|
2379
|
+
_path_params['transactionId'] = transaction_id
|
|
2380
|
+
# process the query parameters
|
|
2381
|
+
# process the header parameters
|
|
2382
|
+
if target_tenant_id is not None:
|
|
2383
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
2384
|
+
# process the form parameters
|
|
2385
|
+
# process the body parameter
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
# set the HTTP header `Accept`
|
|
2389
|
+
if 'Accept' not in _header_params:
|
|
2390
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
2391
|
+
[
|
|
2392
|
+
'application/json'
|
|
2393
|
+
]
|
|
2394
|
+
)
|
|
2395
|
+
|
|
2396
|
+
|
|
2397
|
+
# authentication setting
|
|
2398
|
+
_auth_settings: List[str] = [
|
|
2399
|
+
'CookieAuth',
|
|
2400
|
+
'ApiKeyAuth',
|
|
2401
|
+
'OAuth2Auth',
|
|
2402
|
+
'OAuth2Auth',
|
|
2403
|
+
'BearerAuth'
|
|
2404
|
+
]
|
|
2405
|
+
|
|
2406
|
+
return self.api_client.param_serialize(
|
|
2407
|
+
method='DELETE',
|
|
2408
|
+
resource_path='/v1/data/directloads/{draftId}/transactions/{transactionId}',
|
|
2409
|
+
path_params=_path_params,
|
|
2410
|
+
query_params=_query_params,
|
|
2411
|
+
header_params=_header_params,
|
|
2412
|
+
body=_body_params,
|
|
2413
|
+
post_params=_form_params,
|
|
2414
|
+
files=_files,
|
|
2415
|
+
auth_settings=_auth_settings,
|
|
2416
|
+
collection_formats=_collection_formats,
|
|
2417
|
+
_host=_host,
|
|
2418
|
+
_request_auth=_request_auth
|
|
2419
|
+
)
|
|
2420
|
+
|
|
2421
|
+
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
@validate_call
|
|
2425
|
+
def start_transaction(
|
|
2426
|
+
self,
|
|
2427
|
+
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.")],
|
|
2428
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
2429
|
+
_request_timeout: Union[
|
|
2430
|
+
None,
|
|
2431
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2432
|
+
Tuple[
|
|
2433
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2434
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
2435
|
+
]
|
|
2436
|
+
] = None,
|
|
2437
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
2438
|
+
_content_type: Optional[StrictStr] = None,
|
|
2439
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
2440
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
2441
|
+
) -> DirectDataTransactionStartResponseDTO:
|
|
2442
|
+
"""Start a direct data intake transaction
|
|
2443
|
+
|
|
2444
|
+
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.
|
|
2445
|
+
|
|
2446
|
+
: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)
|
|
2447
|
+
:type draft_id: str
|
|
2448
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
2449
|
+
:type target_tenant_id: str
|
|
2450
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
2451
|
+
number provided, it will be total request
|
|
2452
|
+
timeout. It can also be a pair (tuple) of
|
|
2453
|
+
(connection, read) timeouts.
|
|
2454
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
2455
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2456
|
+
request; this effectively ignores the
|
|
2457
|
+
authentication in the spec for a single request.
|
|
2458
|
+
:type _request_auth: dict, optional
|
|
2459
|
+
:param _content_type: force content-type for the request.
|
|
2460
|
+
:type _content_type: str, Optional
|
|
2461
|
+
:param _headers: set to override the headers for a single
|
|
2462
|
+
request; this effectively ignores the headers
|
|
2463
|
+
in the spec for a single request.
|
|
2464
|
+
:type _headers: dict, optional
|
|
2465
|
+
:param _host_index: set to override the host_index for a single
|
|
2466
|
+
request; this effectively ignores the host_index
|
|
2467
|
+
in the spec for a single request.
|
|
2468
|
+
:type _host_index: int, optional
|
|
2469
|
+
:return: Returns the result object.
|
|
2470
|
+
""" # noqa: E501
|
|
2471
|
+
|
|
2472
|
+
_param = self._start_transaction_serialize(
|
|
2473
|
+
draft_id=draft_id,
|
|
2474
|
+
target_tenant_id=target_tenant_id,
|
|
2475
|
+
_request_auth=_request_auth,
|
|
2476
|
+
_content_type=_content_type,
|
|
2477
|
+
_headers=_headers,
|
|
2478
|
+
_host_index=_host_index
|
|
2479
|
+
)
|
|
2480
|
+
|
|
2481
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
2482
|
+
'200': "DirectDataTransactionStartResponseDTO",
|
|
2483
|
+
}
|
|
2484
|
+
response_data = self.api_client.call_api(
|
|
2485
|
+
*_param,
|
|
2486
|
+
_request_timeout=_request_timeout
|
|
2487
|
+
)
|
|
2488
|
+
response_data.read()
|
|
2489
|
+
return self.api_client.response_deserialize(
|
|
2490
|
+
response_data=response_data,
|
|
2491
|
+
response_types_map=_response_types_map,
|
|
2492
|
+
).data
|
|
2493
|
+
|
|
2494
|
+
|
|
2495
|
+
@validate_call
|
|
2496
|
+
def start_transaction_with_http_info(
|
|
2497
|
+
self,
|
|
2498
|
+
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.")],
|
|
2499
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
2500
|
+
_request_timeout: Union[
|
|
2501
|
+
None,
|
|
2502
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2503
|
+
Tuple[
|
|
2504
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2505
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
2506
|
+
]
|
|
2507
|
+
] = None,
|
|
2508
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
2509
|
+
_content_type: Optional[StrictStr] = None,
|
|
2510
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
2511
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
2512
|
+
) -> ApiResponse[DirectDataTransactionStartResponseDTO]:
|
|
2513
|
+
"""Start a direct data intake transaction
|
|
2514
|
+
|
|
2515
|
+
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.
|
|
2516
|
+
|
|
2517
|
+
: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)
|
|
2518
|
+
:type draft_id: str
|
|
2519
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
2520
|
+
:type target_tenant_id: str
|
|
2521
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
2522
|
+
number provided, it will be total request
|
|
2523
|
+
timeout. It can also be a pair (tuple) of
|
|
2524
|
+
(connection, read) timeouts.
|
|
2525
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
2526
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2527
|
+
request; this effectively ignores the
|
|
2528
|
+
authentication in the spec for a single request.
|
|
2529
|
+
:type _request_auth: dict, optional
|
|
2530
|
+
:param _content_type: force content-type for the request.
|
|
2531
|
+
:type _content_type: str, Optional
|
|
2532
|
+
:param _headers: set to override the headers for a single
|
|
2533
|
+
request; this effectively ignores the headers
|
|
2534
|
+
in the spec for a single request.
|
|
2535
|
+
:type _headers: dict, optional
|
|
2536
|
+
:param _host_index: set to override the host_index for a single
|
|
2537
|
+
request; this effectively ignores the host_index
|
|
2538
|
+
in the spec for a single request.
|
|
2539
|
+
:type _host_index: int, optional
|
|
2540
|
+
:return: Returns the result object.
|
|
2541
|
+
""" # noqa: E501
|
|
2542
|
+
|
|
2543
|
+
_param = self._start_transaction_serialize(
|
|
2544
|
+
draft_id=draft_id,
|
|
2545
|
+
target_tenant_id=target_tenant_id,
|
|
2546
|
+
_request_auth=_request_auth,
|
|
2547
|
+
_content_type=_content_type,
|
|
2548
|
+
_headers=_headers,
|
|
2549
|
+
_host_index=_host_index
|
|
2550
|
+
)
|
|
2551
|
+
|
|
2552
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
2553
|
+
'200': "DirectDataTransactionStartResponseDTO",
|
|
2554
|
+
}
|
|
2555
|
+
response_data = self.api_client.call_api(
|
|
2556
|
+
*_param,
|
|
2557
|
+
_request_timeout=_request_timeout
|
|
2558
|
+
)
|
|
2559
|
+
response_data.read()
|
|
2560
|
+
return self.api_client.response_deserialize(
|
|
2561
|
+
response_data=response_data,
|
|
2562
|
+
response_types_map=_response_types_map,
|
|
2563
|
+
)
|
|
2564
|
+
|
|
2565
|
+
|
|
2566
|
+
@validate_call
|
|
2567
|
+
def start_transaction_without_preload_content(
|
|
2568
|
+
self,
|
|
2569
|
+
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.")],
|
|
2570
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
2571
|
+
_request_timeout: Union[
|
|
2572
|
+
None,
|
|
2573
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2574
|
+
Tuple[
|
|
2575
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2576
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
2577
|
+
]
|
|
2578
|
+
] = None,
|
|
2579
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
2580
|
+
_content_type: Optional[StrictStr] = None,
|
|
2581
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
2582
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
2583
|
+
) -> RESTResponseType:
|
|
2584
|
+
"""Start a direct data intake transaction
|
|
2585
|
+
|
|
2586
|
+
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.
|
|
2587
|
+
|
|
2588
|
+
: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)
|
|
2589
|
+
:type draft_id: str
|
|
2590
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
2591
|
+
:type target_tenant_id: str
|
|
2592
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
2593
|
+
number provided, it will be total request
|
|
2594
|
+
timeout. It can also be a pair (tuple) of
|
|
2595
|
+
(connection, read) timeouts.
|
|
2596
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
2597
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2598
|
+
request; this effectively ignores the
|
|
2599
|
+
authentication in the spec for a single request.
|
|
2600
|
+
:type _request_auth: dict, optional
|
|
2601
|
+
:param _content_type: force content-type for the request.
|
|
2602
|
+
:type _content_type: str, Optional
|
|
2603
|
+
:param _headers: set to override the headers for a single
|
|
2604
|
+
request; this effectively ignores the headers
|
|
2605
|
+
in the spec for a single request.
|
|
2606
|
+
:type _headers: dict, optional
|
|
2607
|
+
:param _host_index: set to override the host_index for a single
|
|
2608
|
+
request; this effectively ignores the host_index
|
|
2609
|
+
in the spec for a single request.
|
|
2610
|
+
:type _host_index: int, optional
|
|
2611
|
+
:return: Returns the result object.
|
|
2612
|
+
""" # noqa: E501
|
|
2613
|
+
|
|
2614
|
+
_param = self._start_transaction_serialize(
|
|
2615
|
+
draft_id=draft_id,
|
|
2616
|
+
target_tenant_id=target_tenant_id,
|
|
2617
|
+
_request_auth=_request_auth,
|
|
2618
|
+
_content_type=_content_type,
|
|
2619
|
+
_headers=_headers,
|
|
2620
|
+
_host_index=_host_index
|
|
2621
|
+
)
|
|
2622
|
+
|
|
2623
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
2624
|
+
'200': "DirectDataTransactionStartResponseDTO",
|
|
2625
|
+
}
|
|
2626
|
+
response_data = self.api_client.call_api(
|
|
2627
|
+
*_param,
|
|
2628
|
+
_request_timeout=_request_timeout
|
|
2629
|
+
)
|
|
2630
|
+
return response_data.response
|
|
2631
|
+
|
|
2632
|
+
|
|
2633
|
+
def _start_transaction_serialize(
|
|
2634
|
+
self,
|
|
2635
|
+
draft_id,
|
|
2636
|
+
target_tenant_id,
|
|
2637
|
+
_request_auth,
|
|
2638
|
+
_content_type,
|
|
2639
|
+
_headers,
|
|
2640
|
+
_host_index,
|
|
2641
|
+
) -> RequestSerialized:
|
|
2642
|
+
|
|
2643
|
+
_host = None
|
|
2644
|
+
|
|
2645
|
+
_collection_formats: Dict[str, str] = {
|
|
2646
|
+
}
|
|
2647
|
+
|
|
2648
|
+
_path_params: Dict[str, str] = {}
|
|
2649
|
+
_query_params: List[Tuple[str, str]] = []
|
|
2650
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
2651
|
+
_form_params: List[Tuple[str, str]] = []
|
|
2652
|
+
_files: Dict[
|
|
2653
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
2654
|
+
] = {}
|
|
2655
|
+
_body_params: Optional[bytes] = None
|
|
2656
|
+
|
|
2657
|
+
# process the path parameters
|
|
2658
|
+
if draft_id is not None:
|
|
2659
|
+
_path_params['draftId'] = draft_id
|
|
2660
|
+
# process the query parameters
|
|
2661
|
+
# process the header parameters
|
|
2662
|
+
if target_tenant_id is not None:
|
|
2663
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
2664
|
+
# process the form parameters
|
|
2665
|
+
# process the body parameter
|
|
2666
|
+
|
|
2667
|
+
|
|
2668
|
+
# set the HTTP header `Accept`
|
|
2669
|
+
if 'Accept' not in _header_params:
|
|
2670
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
2671
|
+
[
|
|
2672
|
+
'application/json'
|
|
2673
|
+
]
|
|
2674
|
+
)
|
|
2675
|
+
|
|
2676
|
+
|
|
2677
|
+
# authentication setting
|
|
2678
|
+
_auth_settings: List[str] = [
|
|
2679
|
+
'CookieAuth',
|
|
2680
|
+
'ApiKeyAuth',
|
|
2681
|
+
'OAuth2Auth',
|
|
2682
|
+
'OAuth2Auth',
|
|
2683
|
+
'BearerAuth'
|
|
2684
|
+
]
|
|
2685
|
+
|
|
2686
|
+
return self.api_client.param_serialize(
|
|
2687
|
+
method='POST',
|
|
2688
|
+
resource_path='/v1/data/directloads/{draftId}/transactions',
|
|
2689
|
+
path_params=_path_params,
|
|
2690
|
+
query_params=_query_params,
|
|
2691
|
+
header_params=_header_params,
|
|
2692
|
+
body=_body_params,
|
|
2693
|
+
post_params=_form_params,
|
|
2694
|
+
files=_files,
|
|
2695
|
+
auth_settings=_auth_settings,
|
|
2696
|
+
collection_formats=_collection_formats,
|
|
2697
|
+
_host=_host,
|
|
2698
|
+
_request_auth=_request_auth
|
|
2699
|
+
)
|
|
2700
|
+
|
|
2701
|
+
|
|
2702
|
+
|
|
2703
|
+
|
|
2704
|
+
@validate_call
|
|
2705
|
+
def upload_file(
|
|
2706
|
+
self,
|
|
2707
|
+
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.")],
|
|
2708
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction to load data files into.")],
|
|
2709
|
+
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`.")],
|
|
2710
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
2711
|
+
file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to upload")] = None,
|
|
2712
|
+
_request_timeout: Union[
|
|
2713
|
+
None,
|
|
2714
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2715
|
+
Tuple[
|
|
2716
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2717
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
2718
|
+
]
|
|
2719
|
+
] = None,
|
|
2720
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
2721
|
+
_content_type: Optional[StrictStr] = None,
|
|
2722
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
2723
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
2724
|
+
) -> DirectDataUploadFileResponseDTO:
|
|
2725
|
+
"""Upload files
|
|
2726
|
+
|
|
2727
|
+
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.
|
|
2728
|
+
|
|
2729
|
+
: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)
|
|
2730
|
+
:type draft_id: str
|
|
2731
|
+
:param transaction_id: The unique identifier of the transaction to load data files into. (required)
|
|
2732
|
+
:type transaction_id: str
|
|
2733
|
+
: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)
|
|
2734
|
+
:type object_name: str
|
|
2735
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
2736
|
+
:type target_tenant_id: str
|
|
2737
|
+
:param file: The file to upload
|
|
2738
|
+
:type file: bytearray
|
|
2739
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
2740
|
+
number provided, it will be total request
|
|
2741
|
+
timeout. It can also be a pair (tuple) of
|
|
2742
|
+
(connection, read) timeouts.
|
|
2743
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
2744
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2745
|
+
request; this effectively ignores the
|
|
2746
|
+
authentication in the spec for a single request.
|
|
2747
|
+
:type _request_auth: dict, optional
|
|
2748
|
+
:param _content_type: force content-type for the request.
|
|
2749
|
+
:type _content_type: str, Optional
|
|
2750
|
+
:param _headers: set to override the headers for a single
|
|
2751
|
+
request; this effectively ignores the headers
|
|
2752
|
+
in the spec for a single request.
|
|
2753
|
+
:type _headers: dict, optional
|
|
2754
|
+
:param _host_index: set to override the host_index for a single
|
|
2755
|
+
request; this effectively ignores the host_index
|
|
2756
|
+
in the spec for a single request.
|
|
2757
|
+
:type _host_index: int, optional
|
|
2758
|
+
:return: Returns the result object.
|
|
2759
|
+
""" # noqa: E501
|
|
2760
|
+
|
|
2761
|
+
_param = self._upload_file_serialize(
|
|
2762
|
+
draft_id=draft_id,
|
|
2763
|
+
transaction_id=transaction_id,
|
|
2764
|
+
object_name=object_name,
|
|
2765
|
+
target_tenant_id=target_tenant_id,
|
|
2766
|
+
file=file,
|
|
2767
|
+
_request_auth=_request_auth,
|
|
2768
|
+
_content_type=_content_type,
|
|
2769
|
+
_headers=_headers,
|
|
2770
|
+
_host_index=_host_index
|
|
2771
|
+
)
|
|
2772
|
+
|
|
2773
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
2774
|
+
'200': "DirectDataUploadFileResponseDTO",
|
|
2775
|
+
}
|
|
2776
|
+
response_data = self.api_client.call_api(
|
|
2777
|
+
*_param,
|
|
2778
|
+
_request_timeout=_request_timeout
|
|
2779
|
+
)
|
|
2780
|
+
response_data.read()
|
|
2781
|
+
return self.api_client.response_deserialize(
|
|
2782
|
+
response_data=response_data,
|
|
2783
|
+
response_types_map=_response_types_map,
|
|
2784
|
+
).data
|
|
2785
|
+
|
|
2786
|
+
|
|
2787
|
+
@validate_call
|
|
2788
|
+
def upload_file_with_http_info(
|
|
2789
|
+
self,
|
|
2790
|
+
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.")],
|
|
2791
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction to load data files into.")],
|
|
2792
|
+
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`.")],
|
|
2793
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
2794
|
+
file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to upload")] = None,
|
|
2795
|
+
_request_timeout: Union[
|
|
2796
|
+
None,
|
|
2797
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2798
|
+
Tuple[
|
|
2799
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2800
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
2801
|
+
]
|
|
2802
|
+
] = None,
|
|
2803
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
2804
|
+
_content_type: Optional[StrictStr] = None,
|
|
2805
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
2806
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
2807
|
+
) -> ApiResponse[DirectDataUploadFileResponseDTO]:
|
|
2808
|
+
"""Upload files
|
|
2809
|
+
|
|
2810
|
+
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.
|
|
2811
|
+
|
|
2812
|
+
: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)
|
|
2813
|
+
:type draft_id: str
|
|
2814
|
+
:param transaction_id: The unique identifier of the transaction to load data files into. (required)
|
|
2815
|
+
:type transaction_id: str
|
|
2816
|
+
: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)
|
|
2817
|
+
:type object_name: str
|
|
2818
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
2819
|
+
:type target_tenant_id: str
|
|
2820
|
+
:param file: The file to upload
|
|
2821
|
+
:type file: bytearray
|
|
2822
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
2823
|
+
number provided, it will be total request
|
|
2824
|
+
timeout. It can also be a pair (tuple) of
|
|
2825
|
+
(connection, read) timeouts.
|
|
2826
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
2827
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2828
|
+
request; this effectively ignores the
|
|
2829
|
+
authentication in the spec for a single request.
|
|
2830
|
+
:type _request_auth: dict, optional
|
|
2831
|
+
:param _content_type: force content-type for the request.
|
|
2832
|
+
:type _content_type: str, Optional
|
|
2833
|
+
:param _headers: set to override the headers for a single
|
|
2834
|
+
request; this effectively ignores the headers
|
|
2835
|
+
in the spec for a single request.
|
|
2836
|
+
:type _headers: dict, optional
|
|
2837
|
+
:param _host_index: set to override the host_index for a single
|
|
2838
|
+
request; this effectively ignores the host_index
|
|
2839
|
+
in the spec for a single request.
|
|
2840
|
+
:type _host_index: int, optional
|
|
2841
|
+
:return: Returns the result object.
|
|
2842
|
+
""" # noqa: E501
|
|
2843
|
+
|
|
2844
|
+
_param = self._upload_file_serialize(
|
|
2845
|
+
draft_id=draft_id,
|
|
2846
|
+
transaction_id=transaction_id,
|
|
2847
|
+
object_name=object_name,
|
|
2848
|
+
target_tenant_id=target_tenant_id,
|
|
2849
|
+
file=file,
|
|
2850
|
+
_request_auth=_request_auth,
|
|
2851
|
+
_content_type=_content_type,
|
|
2852
|
+
_headers=_headers,
|
|
2853
|
+
_host_index=_host_index
|
|
2854
|
+
)
|
|
2855
|
+
|
|
2856
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
2857
|
+
'200': "DirectDataUploadFileResponseDTO",
|
|
2858
|
+
}
|
|
2859
|
+
response_data = self.api_client.call_api(
|
|
2860
|
+
*_param,
|
|
2861
|
+
_request_timeout=_request_timeout
|
|
2862
|
+
)
|
|
2863
|
+
response_data.read()
|
|
2864
|
+
return self.api_client.response_deserialize(
|
|
2865
|
+
response_data=response_data,
|
|
2866
|
+
response_types_map=_response_types_map,
|
|
2867
|
+
)
|
|
2868
|
+
|
|
2869
|
+
|
|
2870
|
+
@validate_call
|
|
2871
|
+
def upload_file_without_preload_content(
|
|
2872
|
+
self,
|
|
2873
|
+
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.")],
|
|
2874
|
+
transaction_id: Annotated[StrictStr, Field(description="The unique identifier of the transaction to load data files into.")],
|
|
2875
|
+
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`.")],
|
|
2876
|
+
target_tenant_id: Annotated[Optional[StrictStr], Field(description="Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.")] = None,
|
|
2877
|
+
file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to upload")] = None,
|
|
2878
|
+
_request_timeout: Union[
|
|
2879
|
+
None,
|
|
2880
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2881
|
+
Tuple[
|
|
2882
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
2883
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
2884
|
+
]
|
|
2885
|
+
] = None,
|
|
2886
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
2887
|
+
_content_type: Optional[StrictStr] = None,
|
|
2888
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
2889
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
2890
|
+
) -> RESTResponseType:
|
|
2891
|
+
"""Upload files
|
|
2892
|
+
|
|
2893
|
+
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.
|
|
2894
|
+
|
|
2895
|
+
: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)
|
|
2896
|
+
:type draft_id: str
|
|
2897
|
+
:param transaction_id: The unique identifier of the transaction to load data files into. (required)
|
|
2898
|
+
:type transaction_id: str
|
|
2899
|
+
: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)
|
|
2900
|
+
:type object_name: str
|
|
2901
|
+
:param target_tenant_id: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
|
|
2902
|
+
:type target_tenant_id: str
|
|
2903
|
+
:param file: The file to upload
|
|
2904
|
+
:type file: bytearray
|
|
2905
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
2906
|
+
number provided, it will be total request
|
|
2907
|
+
timeout. It can also be a pair (tuple) of
|
|
2908
|
+
(connection, read) timeouts.
|
|
2909
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
2910
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2911
|
+
request; this effectively ignores the
|
|
2912
|
+
authentication in the spec for a single request.
|
|
2913
|
+
:type _request_auth: dict, optional
|
|
2914
|
+
:param _content_type: force content-type for the request.
|
|
2915
|
+
:type _content_type: str, Optional
|
|
2916
|
+
:param _headers: set to override the headers for a single
|
|
2917
|
+
request; this effectively ignores the headers
|
|
2918
|
+
in the spec for a single request.
|
|
2919
|
+
:type _headers: dict, optional
|
|
2920
|
+
:param _host_index: set to override the host_index for a single
|
|
2921
|
+
request; this effectively ignores the host_index
|
|
2922
|
+
in the spec for a single request.
|
|
2923
|
+
:type _host_index: int, optional
|
|
2924
|
+
:return: Returns the result object.
|
|
2925
|
+
""" # noqa: E501
|
|
2926
|
+
|
|
2927
|
+
_param = self._upload_file_serialize(
|
|
2928
|
+
draft_id=draft_id,
|
|
2929
|
+
transaction_id=transaction_id,
|
|
2930
|
+
object_name=object_name,
|
|
2931
|
+
target_tenant_id=target_tenant_id,
|
|
2932
|
+
file=file,
|
|
2933
|
+
_request_auth=_request_auth,
|
|
2934
|
+
_content_type=_content_type,
|
|
2935
|
+
_headers=_headers,
|
|
2936
|
+
_host_index=_host_index
|
|
2937
|
+
)
|
|
2938
|
+
|
|
2939
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
2940
|
+
'200': "DirectDataUploadFileResponseDTO",
|
|
2941
|
+
}
|
|
2942
|
+
response_data = self.api_client.call_api(
|
|
2943
|
+
*_param,
|
|
2944
|
+
_request_timeout=_request_timeout
|
|
2945
|
+
)
|
|
2946
|
+
return response_data.response
|
|
2947
|
+
|
|
2948
|
+
|
|
2949
|
+
def _upload_file_serialize(
|
|
2950
|
+
self,
|
|
2951
|
+
draft_id,
|
|
2952
|
+
transaction_id,
|
|
2953
|
+
object_name,
|
|
2954
|
+
target_tenant_id,
|
|
2955
|
+
file,
|
|
2956
|
+
_request_auth,
|
|
2957
|
+
_content_type,
|
|
2958
|
+
_headers,
|
|
2959
|
+
_host_index,
|
|
2960
|
+
) -> RequestSerialized:
|
|
2961
|
+
|
|
2962
|
+
_host = None
|
|
2963
|
+
|
|
2964
|
+
_collection_formats: Dict[str, str] = {
|
|
2965
|
+
}
|
|
2966
|
+
|
|
2967
|
+
_path_params: Dict[str, str] = {}
|
|
2968
|
+
_query_params: List[Tuple[str, str]] = []
|
|
2969
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
2970
|
+
_form_params: List[Tuple[str, str]] = []
|
|
2971
|
+
_files: Dict[
|
|
2972
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
2973
|
+
] = {}
|
|
2974
|
+
_body_params: Optional[bytes] = None
|
|
2975
|
+
|
|
2976
|
+
# process the path parameters
|
|
2977
|
+
if draft_id is not None:
|
|
2978
|
+
_path_params['draftId'] = draft_id
|
|
2979
|
+
if transaction_id is not None:
|
|
2980
|
+
_path_params['transactionId'] = transaction_id
|
|
2981
|
+
if object_name is not None:
|
|
2982
|
+
_path_params['objectName'] = object_name
|
|
2983
|
+
# process the query parameters
|
|
2984
|
+
# process the header parameters
|
|
2985
|
+
if target_tenant_id is not None:
|
|
2986
|
+
_header_params['TargetTenantID'] = target_tenant_id
|
|
2987
|
+
# process the form parameters
|
|
2988
|
+
if file is not None:
|
|
2989
|
+
_files['file'] = file
|
|
2990
|
+
# process the body parameter
|
|
2991
|
+
|
|
2992
|
+
|
|
2993
|
+
# set the HTTP header `Accept`
|
|
2994
|
+
if 'Accept' not in _header_params:
|
|
2995
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
2996
|
+
[
|
|
2997
|
+
'application/json'
|
|
2998
|
+
]
|
|
2999
|
+
)
|
|
3000
|
+
|
|
3001
|
+
# set the HTTP header `Content-Type`
|
|
3002
|
+
if _content_type:
|
|
3003
|
+
_header_params['Content-Type'] = _content_type
|
|
3004
|
+
else:
|
|
3005
|
+
_default_content_type = (
|
|
3006
|
+
self.api_client.select_header_content_type(
|
|
3007
|
+
[
|
|
3008
|
+
'multipart/form-data'
|
|
3009
|
+
]
|
|
3010
|
+
)
|
|
3011
|
+
)
|
|
3012
|
+
if _default_content_type is not None:
|
|
3013
|
+
_header_params['Content-Type'] = _default_content_type
|
|
3014
|
+
|
|
3015
|
+
# authentication setting
|
|
3016
|
+
_auth_settings: List[str] = [
|
|
3017
|
+
'CookieAuth',
|
|
3018
|
+
'ApiKeyAuth',
|
|
3019
|
+
'OAuth2Auth',
|
|
3020
|
+
'OAuth2Auth',
|
|
3021
|
+
'BearerAuth'
|
|
3022
|
+
]
|
|
3023
|
+
|
|
3024
|
+
return self.api_client.param_serialize(
|
|
3025
|
+
method='PUT',
|
|
3026
|
+
resource_path='/v1/data/directloads/{draftId}/transactions/{transactionId}/{objectName}',
|
|
3027
|
+
path_params=_path_params,
|
|
3028
|
+
query_params=_query_params,
|
|
3029
|
+
header_params=_header_params,
|
|
3030
|
+
body=_body_params,
|
|
3031
|
+
post_params=_form_params,
|
|
3032
|
+
files=_files,
|
|
3033
|
+
auth_settings=_auth_settings,
|
|
3034
|
+
collection_formats=_collection_formats,
|
|
3035
|
+
_host=_host,
|
|
3036
|
+
_request_auth=_request_auth
|
|
3037
|
+
)
|
|
3038
|
+
|
|
3039
|
+
|