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.

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