visier-platform-sdk 22222222.99201.1892b3__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 (664) hide show
  1. visier_platform_sdk/__init__.py +684 -0
  2. visier_platform_sdk/api/__init__.py +42 -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 +8346 -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/direct_data_intake_api.py +3039 -0
  15. visier_platform_sdk/api/email_domains_api.py +880 -0
  16. visier_platform_sdk/api/encryption_keys_api.py +835 -0
  17. visier_platform_sdk/api/jobs_library_api.py +1168 -0
  18. visier_platform_sdk/api/network_subnets_api.py +1170 -0
  19. visier_platform_sdk/api/o_auth2_api.py +1021 -0
  20. visier_platform_sdk/api/object_configuration_api.py +1752 -0
  21. visier_platform_sdk/api/permissions_api.py +4295 -0
  22. visier_platform_sdk/api/pgp_key_api.py +1161 -0
  23. visier_platform_sdk/api/planning_data_load_api.py +740 -0
  24. visier_platform_sdk/api/production_versions_api.py +944 -0
  25. visier_platform_sdk/api/profiles_api.py +2873 -0
  26. visier_platform_sdk/api/projects_api.py +2128 -0
  27. visier_platform_sdk/api/release_version_configuration_api.py +835 -0
  28. visier_platform_sdk/api/reporting_api.py +1757 -0
  29. visier_platform_sdk/api/search_api.py +356 -0
  30. visier_platform_sdk/api/skills_library_api.py +2632 -0
  31. visier_platform_sdk/api/source_files_download_api.py +335 -0
  32. visier_platform_sdk/api/sources_api.py +652 -0
  33. visier_platform_sdk/api/system_status_api.py +570 -0
  34. visier_platform_sdk/api/tenants_v1_api.py +2836 -0
  35. visier_platform_sdk/api/tenants_v2_api.py +1595 -0
  36. visier_platform_sdk/api/user_groups_v2_api.py +2332 -0
  37. visier_platform_sdk/api/users_v1_api.py +6157 -0
  38. visier_platform_sdk/api/users_v2_api.py +973 -0
  39. visier_platform_sdk/api/vee_api.py +1161 -0
  40. visier_platform_sdk/api/webhooks_api.py +2281 -0
  41. visier_platform_sdk/api_client.py +811 -0
  42. visier_platform_sdk/api_response.py +21 -0
  43. visier_platform_sdk/configuration.py +808 -0
  44. visier_platform_sdk/exceptions.py +217 -0
  45. visier_platform_sdk/models/__init__.py +630 -0
  46. visier_platform_sdk/models/admin_all_tenants_status_apidto.py +100 -0
  47. visier_platform_sdk/models/admin_assign_connector_credentials_by_tenant_response_dto.py +112 -0
  48. visier_platform_sdk/models/admin_assign_connector_credentials_response_dto.py +96 -0
  49. visier_platform_sdk/models/admin_assign_connector_with_credentials_response_dto.py +98 -0
  50. visier_platform_sdk/models/admin_assigned_credential_info_response_dto.py +92 -0
  51. visier_platform_sdk/models/admin_batch_tenant_provision_apidto.py +96 -0
  52. visier_platform_sdk/models/admin_business_location_dto.py +90 -0
  53. visier_platform_sdk/models/admin_connector_info_response_dto.py +92 -0
  54. visier_platform_sdk/models/admin_connector_setting_request_dto.py +90 -0
  55. visier_platform_sdk/models/admin_connector_setting_response_dto.py +92 -0
  56. visier_platform_sdk/models/admin_connector_settings_response_dto.py +102 -0
  57. visier_platform_sdk/models/admin_consolidated_analytics_api_excluded_source_list_dto.py +88 -0
  58. visier_platform_sdk/models/admin_consolidated_analytics_api_source_tenant_list_dto.py +88 -0
  59. visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_create_request_dto.py +88 -0
  60. visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_list_response_dto.py +88 -0
  61. visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details.py +92 -0
  62. visier_platform_sdk/models/admin_consolidated_analytics_api_tenant_with_details_list_response_dto.py +96 -0
  63. visier_platform_sdk/models/admin_custom_property_dto.py +90 -0
  64. visier_platform_sdk/models/admin_custom_tenant_property_dto.py +90 -0
  65. visier_platform_sdk/models/admin_data_import_definition_apidto.py +92 -0
  66. visier_platform_sdk/models/admin_data_import_definitions_apidto.py +100 -0
  67. visier_platform_sdk/models/admin_data_version_and_date_dto.py +90 -0
  68. visier_platform_sdk/models/admin_delete_user_group_v2_request.py +88 -0
  69. visier_platform_sdk/models/admin_element_ids_dto.py +88 -0
  70. visier_platform_sdk/models/admin_email_domains_dto.py +90 -0
  71. visier_platform_sdk/models/admin_excluded_sources_body.py +88 -0
  72. visier_platform_sdk/models/admin_extractor_setting_apidto.py +100 -0
  73. visier_platform_sdk/models/admin_extractor_setting_key_value_apidto.py +90 -0
  74. visier_platform_sdk/models/admin_extractor_settings_apidto.py +96 -0
  75. visier_platform_sdk/models/admin_home_analysis_by_user_group_dto.py +90 -0
  76. visier_platform_sdk/models/admin_jobs_consolidated_analytics_job_request_dto.py +88 -0
  77. visier_platform_sdk/models/admin_jobs_extract_data_and_load_dto.py +150 -0
  78. visier_platform_sdk/models/admin_jobs_processing_job_request_dto.py +96 -0
  79. visier_platform_sdk/models/admin_key_name.py +88 -0
  80. visier_platform_sdk/models/admin_mask_message.py +88 -0
  81. visier_platform_sdk/models/admin_multiple_tenant_data_versions_details_dto.py +98 -0
  82. visier_platform_sdk/models/admin_multiple_tenant_data_versions_list_dto.py +100 -0
  83. visier_platform_sdk/models/admin_network_subnets_message_request.py +90 -0
  84. visier_platform_sdk/models/admin_network_subnets_message_response.py +88 -0
  85. visier_platform_sdk/models/admin_permission_response_dto.py +90 -0
  86. visier_platform_sdk/models/admin_permissions_list_dto.py +96 -0
  87. visier_platform_sdk/models/admin_permissions_to_user_group_for_tenant_dto.py +102 -0
  88. visier_platform_sdk/models/admin_permissions_to_user_group_request_dto.py +90 -0
  89. visier_platform_sdk/models/admin_permissions_to_user_groups_request_dto.py +96 -0
  90. visier_platform_sdk/models/admin_product_release_dto.py +94 -0
  91. visier_platform_sdk/models/admin_product_releases_dto.py +96 -0
  92. visier_platform_sdk/models/admin_product_version_dto.py +92 -0
  93. visier_platform_sdk/models/admin_product_versions_dto.py +96 -0
  94. visier_platform_sdk/models/admin_product_versions_update_failure_tenant_response_dto.py +94 -0
  95. visier_platform_sdk/models/admin_product_versions_update_response_dto.py +106 -0
  96. visier_platform_sdk/models/admin_product_versions_update_successful_tenant_response_dto.py +92 -0
  97. visier_platform_sdk/models/admin_put_project_commits_request.py +88 -0
  98. visier_platform_sdk/models/admin_security_assignment_response_dto.py +96 -0
  99. visier_platform_sdk/models/admin_set_connector_setting_request_dto.py +98 -0
  100. visier_platform_sdk/models/admin_set_connector_setting_response_dto.py +112 -0
  101. visier_platform_sdk/models/admin_set_connector_settings_request_dto.py +96 -0
  102. visier_platform_sdk/models/admin_set_connector_settings_response_dto.py +96 -0
  103. visier_platform_sdk/models/admin_simple_user_dto.py +90 -0
  104. visier_platform_sdk/models/admin_target_project_for_tenant_dto.py +90 -0
  105. visier_platform_sdk/models/admin_target_project_for_tenants_list_dto.py +96 -0
  106. visier_platform_sdk/models/admin_tenant_assignments_dto.py +114 -0
  107. visier_platform_sdk/models/admin_tenant_code_body.py +88 -0
  108. visier_platform_sdk/models/admin_tenant_connector_settings_request_dto.py +98 -0
  109. visier_platform_sdk/models/admin_tenant_detail_apidto.py +130 -0
  110. visier_platform_sdk/models/admin_tenant_details_traits_dto.py +112 -0
  111. visier_platform_sdk/models/admin_tenant_management_api_get_response_dto.py +156 -0
  112. visier_platform_sdk/models/admin_tenant_management_api_list_response_dto.py +100 -0
  113. visier_platform_sdk/models/admin_tenant_management_api_update_request_dto.py +156 -0
  114. visier_platform_sdk/models/admin_tenant_management_api_update_response_dto.py +136 -0
  115. visier_platform_sdk/models/admin_tenant_provision_apidto.py +110 -0
  116. visier_platform_sdk/models/admin_tenant_status_apidto.py +94 -0
  117. visier_platform_sdk/models/admin_update_tenant_model.py +98 -0
  118. visier_platform_sdk/models/admin_user_group_change_definition_dto.py +108 -0
  119. visier_platform_sdk/models/admin_user_group_change_dimension_filter_dto.py +104 -0
  120. visier_platform_sdk/models/admin_user_group_change_failure_dto.py +96 -0
  121. visier_platform_sdk/models/admin_user_group_change_filter_dto.py +100 -0
  122. visier_platform_sdk/models/admin_user_group_change_member_selection_dto.py +90 -0
  123. visier_platform_sdk/models/admin_user_group_change_response_dto.py +106 -0
  124. visier_platform_sdk/models/admin_user_group_change_success_dto.py +94 -0
  125. visier_platform_sdk/models/admin_user_group_change_users_dto.py +105 -0
  126. visier_platform_sdk/models/admin_user_group_delete_dto.py +92 -0
  127. visier_platform_sdk/models/admin_user_group_delete_failure_dto.py +96 -0
  128. visier_platform_sdk/models/admin_user_group_delete_response_dto.py +106 -0
  129. visier_platform_sdk/models/admin_user_group_delete_success_dto.py +92 -0
  130. visier_platform_sdk/models/admin_user_group_filters_dto.py +96 -0
  131. visier_platform_sdk/models/admin_user_group_get_api_response_dto.py +100 -0
  132. visier_platform_sdk/models/admin_user_group_single_delete_response_dto.py +98 -0
  133. visier_platform_sdk/models/admin_user_groups_change_dto.py +96 -0
  134. visier_platform_sdk/models/admin_user_groups_delete_request_dto.py +96 -0
  135. visier_platform_sdk/models/admin_user_groups_get_api_response_dto.py +100 -0
  136. visier_platform_sdk/models/admin_user_groups_users_dto.py +100 -0
  137. visier_platform_sdk/models/admin_user_groups_users_for_tenant_dto.py +98 -0
  138. visier_platform_sdk/models/admin_user_security_assignments_dto.py +100 -0
  139. visier_platform_sdk/models/admin_users_to_user_group_request_dto.py +90 -0
  140. visier_platform_sdk/models/admin_users_to_user_groups_request_dto.py +102 -0
  141. visier_platform_sdk/models/analysis_common_report_create_request_dto.py +90 -0
  142. visier_platform_sdk/models/analysis_common_report_delete_success_dto.py +88 -0
  143. visier_platform_sdk/models/analysis_common_report_dto.py +115 -0
  144. visier_platform_sdk/models/analysis_common_report_list_response_dto.py +96 -0
  145. visier_platform_sdk/models/analysis_common_vee_clarification_dto.py +98 -0
  146. visier_platform_sdk/models/analysis_common_vee_conversation_state_dto.py +88 -0
  147. visier_platform_sdk/models/analysis_common_vee_corrections_dto.py +109 -0
  148. visier_platform_sdk/models/analysis_common_vee_data_dto.py +90 -0
  149. visier_platform_sdk/models/analysis_common_vee_feedback_dto.py +96 -0
  150. visier_platform_sdk/models/analysis_common_vee_options_dto.py +110 -0
  151. visier_platform_sdk/models/analysis_common_vee_question_dto.py +102 -0
  152. visier_platform_sdk/models/analysis_common_vee_response_dto.py +132 -0
  153. visier_platform_sdk/models/analysis_common_vee_response_schema_dto.py +107 -0
  154. visier_platform_sdk/models/analysis_common_vee_response_schema_reference_dto.py +90 -0
  155. visier_platform_sdk/models/analysis_common_vee_sample_question_dto.py +94 -0
  156. visier_platform_sdk/models/analysis_common_vee_sample_question_library_dto.py +96 -0
  157. visier_platform_sdk/models/analysis_common_vee_status_code_dto.py +100 -0
  158. visier_platform_sdk/models/analysis_common_vee_visual_dto.py +92 -0
  159. visier_platform_sdk/models/analysis_common_vee_visual_options_dto.py +90 -0
  160. visier_platform_sdk/models/api_error.py +92 -0
  161. visier_platform_sdk/models/authentication_o_auth2_user_info_dto.py +117 -0
  162. visier_platform_sdk/models/authentication_o_auth2_user_subnet_info_dto.py +100 -0
  163. visier_platform_sdk/models/authentication_o_auth2_user_tenant_detail_dto.py +96 -0
  164. visier_platform_sdk/models/authentication_o_auth2_user_tenant_details_dto.py +96 -0
  165. visier_platform_sdk/models/authentication_o_auth2_user_tenant_properties_dto.py +88 -0
  166. visier_platform_sdk/models/benchmark_info.py +92 -0
  167. visier_platform_sdk/models/benchmark_value.py +108 -0
  168. visier_platform_sdk/models/data_in_assign_connector_credential_request.py +96 -0
  169. visier_platform_sdk/models/data_in_connector.py +98 -0
  170. visier_platform_sdk/models/data_in_data_load_request.py +92 -0
  171. visier_platform_sdk/models/data_in_data_load_request_model.py +90 -0
  172. visier_platform_sdk/models/data_in_data_load_response.py +88 -0
  173. visier_platform_sdk/models/data_in_data_transfer_result_detail.py +94 -0
  174. visier_platform_sdk/models/data_in_data_version_object.py +90 -0
  175. visier_platform_sdk/models/data_in_disable_dv_model.py +96 -0
  176. visier_platform_sdk/models/data_in_disable_dv_request.py +92 -0
  177. visier_platform_sdk/models/data_in_disable_dv_response.py +100 -0
  178. visier_platform_sdk/models/data_in_dispatching_job_status_response.py +94 -0
  179. visier_platform_sdk/models/data_in_exclude_data_uploads_request.py +96 -0
  180. visier_platform_sdk/models/data_in_extraction_job.py +94 -0
  181. visier_platform_sdk/models/data_in_extraction_job_and_status_response.py +104 -0
  182. visier_platform_sdk/models/data_in_include_data_uploads_request.py +96 -0
  183. visier_platform_sdk/models/data_in_job_status_list_response.py +100 -0
  184. visier_platform_sdk/models/data_in_job_status_with_start_time.py +96 -0
  185. visier_platform_sdk/models/data_in_processing_job.py +96 -0
  186. visier_platform_sdk/models/data_in_processing_job_and_status_response.py +104 -0
  187. visier_platform_sdk/models/data_in_processing_job_status_response.py +104 -0
  188. visier_platform_sdk/models/data_in_push_data_cancel_response.py +102 -0
  189. visier_platform_sdk/models/data_in_push_data_complete_request.py +90 -0
  190. visier_platform_sdk/models/data_in_push_data_complete_response.py +104 -0
  191. visier_platform_sdk/models/data_in_push_data_response.py +104 -0
  192. visier_platform_sdk/models/data_in_receiving_job.py +92 -0
  193. visier_platform_sdk/models/data_in_receiving_job_and_status_response.py +104 -0
  194. visier_platform_sdk/models/data_in_receiving_job_status_response.py +104 -0
  195. visier_platform_sdk/models/data_in_result.py +96 -0
  196. visier_platform_sdk/models/data_in_source.py +98 -0
  197. visier_platform_sdk/models/data_in_start_extraction_response.py +88 -0
  198. visier_platform_sdk/models/data_in_start_transfer_response.py +88 -0
  199. visier_platform_sdk/models/data_in_tenant.py +100 -0
  200. visier_platform_sdk/models/data_in_tenant_and_credential.py +90 -0
  201. visier_platform_sdk/models/data_in_upload_to_exclude.py +98 -0
  202. visier_platform_sdk/models/data_in_upload_to_include.py +98 -0
  203. visier_platform_sdk/models/data_out_list_response.py +101 -0
  204. visier_platform_sdk/models/dataservices_common_dimension_member_reference_dto.py +90 -0
  205. visier_platform_sdk/models/dataservices_common_member_values_dto.py +105 -0
  206. visier_platform_sdk/models/dataservices_datamodel_aggregation_type_option_dto.py +96 -0
  207. visier_platform_sdk/models/dataservices_datamodel_aggregation_type_parameter_dto.py +102 -0
  208. visier_platform_sdk/models/dataservices_datamodel_analytic_object_dto.py +130 -0
  209. visier_platform_sdk/models/dataservices_datamodel_analytic_objects_dto.py +96 -0
  210. visier_platform_sdk/models/dataservices_datamodel_currencies_dto.py +96 -0
  211. visier_platform_sdk/models/dataservices_datamodel_currency_dto.py +94 -0
  212. visier_platform_sdk/models/dataservices_datamodel_currency_rate_dto.py +96 -0
  213. visier_platform_sdk/models/dataservices_datamodel_currency_rates_dto.py +96 -0
  214. visier_platform_sdk/models/dataservices_datamodel_dimension_dto.py +120 -0
  215. visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_dto.py +102 -0
  216. visier_platform_sdk/models/dataservices_datamodel_dimension_mapping_validation_execution_dto.py +90 -0
  217. visier_platform_sdk/models/dataservices_datamodel_dimension_reference_dto.py +90 -0
  218. visier_platform_sdk/models/dataservices_datamodel_dimensions_dto.py +96 -0
  219. visier_platform_sdk/models/dataservices_datamodel_level_dto.py +92 -0
  220. visier_platform_sdk/models/dataservices_datamodel_member_dto.py +106 -0
  221. visier_platform_sdk/models/dataservices_datamodel_member_parameter_definition_dto.py +102 -0
  222. visier_platform_sdk/models/dataservices_datamodel_members_dto.py +96 -0
  223. visier_platform_sdk/models/dataservices_datamodel_metric_dto.py +122 -0
  224. visier_platform_sdk/models/dataservices_datamodel_metrics_dto.py +96 -0
  225. visier_platform_sdk/models/dataservices_datamodel_numeric_parameter_definition_dto.py +98 -0
  226. visier_platform_sdk/models/dataservices_datamodel_object_reference_dto.py +110 -0
  227. visier_platform_sdk/models/dataservices_datamodel_parameter_definition_dto.py +110 -0
  228. visier_platform_sdk/models/dataservices_datamodel_plan_parameter_definition_dto.py +94 -0
  229. visier_platform_sdk/models/dataservices_datamodel_planning_concept_filter_context_dto.py +88 -0
  230. visier_platform_sdk/models/dataservices_datamodel_planning_hierarchy_filter_context_dto.py +92 -0
  231. visier_platform_sdk/models/dataservices_datamodel_planning_model_dto.py +92 -0
  232. visier_platform_sdk/models/dataservices_datamodel_planning_models_dto.py +96 -0
  233. visier_platform_sdk/models/dataservices_datamodel_planning_plan_context_dto.py +98 -0
  234. visier_platform_sdk/models/dataservices_datamodel_planning_plan_dto.py +123 -0
  235. visier_platform_sdk/models/dataservices_datamodel_planning_plans_dto.py +96 -0
  236. visier_platform_sdk/models/dataservices_datamodel_population_configuration_dto.py +115 -0
  237. visier_platform_sdk/models/dataservices_datamodel_prediction_dto.py +124 -0
  238. visier_platform_sdk/models/dataservices_datamodel_predictions_dto.py +96 -0
  239. visier_platform_sdk/models/dataservices_datamodel_properties_dto.py +96 -0
  240. visier_platform_sdk/models/dataservices_datamodel_property_dto.py +118 -0
  241. visier_platform_sdk/models/dataservices_datamodel_property_reference_dto.py +90 -0
  242. visier_platform_sdk/models/dataservices_datamodel_scenario_or_snapshot_dto.py +90 -0
  243. visier_platform_sdk/models/dataservices_datamodel_selection_concept_dto.py +106 -0
  244. visier_platform_sdk/models/dataservices_datamodel_selection_concept_reference_dto.py +90 -0
  245. visier_platform_sdk/models/dataservices_datamodel_selection_concepts_dto.py +96 -0
  246. visier_platform_sdk/models/dataservices_datamodel_tag_map_element_dto.py +90 -0
  247. visier_platform_sdk/models/dataservices_datamodel_validity_range_dto.py +90 -0
  248. visier_platform_sdk/models/dataservices_query_aggregation_query_dto.py +128 -0
  249. visier_platform_sdk/models/dataservices_query_aggregation_query_execution_dto.py +98 -0
  250. visier_platform_sdk/models/dataservices_query_aggregation_query_source_dto.py +96 -0
  251. visier_platform_sdk/models/dataservices_query_aggregation_query_source_metric_dto.py +94 -0
  252. visier_platform_sdk/models/dataservices_query_aggregation_query_source_metrics_dto.py +96 -0
  253. visier_platform_sdk/models/dataservices_query_aggregation_type_parameter_value_dto.py +90 -0
  254. visier_platform_sdk/models/dataservices_query_cell_distribution_bin_dto.py +90 -0
  255. visier_platform_sdk/models/dataservices_query_cell_distribution_options_dto.py +88 -0
  256. visier_platform_sdk/models/dataservices_query_cell_dto.py +102 -0
  257. visier_platform_sdk/models/dataservices_query_cell_set_axis_dto.py +102 -0
  258. visier_platform_sdk/models/dataservices_query_cell_set_axis_position_dto.py +92 -0
  259. visier_platform_sdk/models/dataservices_query_cell_set_dto.py +114 -0
  260. visier_platform_sdk/models/dataservices_query_cell_set_or_error_dto.py +98 -0
  261. visier_platform_sdk/models/dataservices_query_cohort_filter_dto.py +100 -0
  262. visier_platform_sdk/models/dataservices_query_internal_query_execution_options_dto.py +100 -0
  263. visier_platform_sdk/models/dataservices_query_key_group_filter_dto.py +96 -0
  264. visier_platform_sdk/models/dataservices_query_key_group_filter_item_dto.py +100 -0
  265. visier_platform_sdk/models/dataservices_query_lineage_dto.py +100 -0
  266. visier_platform_sdk/models/dataservices_query_list_query_execution_dto.py +144 -0
  267. visier_platform_sdk/models/dataservices_query_list_query_execution_options_dto.py +158 -0
  268. visier_platform_sdk/models/dataservices_query_list_query_source_dto.py +94 -0
  269. visier_platform_sdk/models/dataservices_query_member_filter_dto.py +98 -0
  270. visier_platform_sdk/models/dataservices_query_member_parameter_value_dto.py +98 -0
  271. visier_platform_sdk/models/dataservices_query_numeric_parameter_value_dto.py +90 -0
  272. visier_platform_sdk/models/dataservices_query_plan_parameter_value_dto.py +94 -0
  273. visier_platform_sdk/models/dataservices_query_property_column_dto.py +94 -0
  274. visier_platform_sdk/models/dataservices_query_query_axis_dto.py +141 -0
  275. visier_platform_sdk/models/dataservices_query_query_axis_options_dto.py +100 -0
  276. visier_platform_sdk/models/dataservices_query_query_dimension_data_member_selection_dto.py +92 -0
  277. visier_platform_sdk/models/dataservices_query_query_dimension_leaf_selection_dto.py +92 -0
  278. visier_platform_sdk/models/dataservices_query_query_dimension_level_property_dto.py +108 -0
  279. visier_platform_sdk/models/dataservices_query_query_dimension_level_selection_dto.py +96 -0
  280. visier_platform_sdk/models/dataservices_query_query_dimension_member_selection_dto.py +102 -0
  281. visier_platform_sdk/models/dataservices_query_query_execution_error_details_dto.py +94 -0
  282. visier_platform_sdk/models/dataservices_query_query_execution_error_dto.py +100 -0
  283. visier_platform_sdk/models/dataservices_query_query_execution_errors_dto.py +100 -0
  284. visier_platform_sdk/models/dataservices_query_query_execution_options_dto.py +192 -0
  285. visier_platform_sdk/models/dataservices_query_query_filter_dto.py +106 -0
  286. visier_platform_sdk/models/dataservices_query_query_member_map_property_dto.py +94 -0
  287. visier_platform_sdk/models/dataservices_query_query_member_map_selection_dto.py +104 -0
  288. visier_platform_sdk/models/dataservices_query_query_numeric_ranges_dto.py +100 -0
  289. visier_platform_sdk/models/dataservices_query_query_parameter_value_dto.py +110 -0
  290. visier_platform_sdk/models/dataservices_query_query_property_dto.py +120 -0
  291. visier_platform_sdk/models/dataservices_query_query_time_interval_dto.py +134 -0
  292. visier_platform_sdk/models/dataservices_query_query_time_intervals_dto.py +150 -0
  293. visier_platform_sdk/models/dataservices_query_snapshot_query_execution_dto.py +144 -0
  294. visier_platform_sdk/models/dataservices_query_snapshot_query_execution_options_dto.py +134 -0
  295. visier_platform_sdk/models/dataservices_query_sort_option_dto.py +100 -0
  296. visier_platform_sdk/models/dataservices_query_sql_like_query_execution_dto.py +94 -0
  297. visier_platform_sdk/models/dataservices_query_time_shift_dto.py +112 -0
  298. visier_platform_sdk/models/description_entry.py +90 -0
  299. visier_platform_sdk/models/designer_adp_auth_params_dto.py +88 -0
  300. visier_platform_sdk/models/designer_api_analytic_object_filter_dto.py +100 -0
  301. visier_platform_sdk/models/designer_api_calculation_concept_configuration_dto.py +96 -0
  302. visier_platform_sdk/models/designer_api_calculation_concept_configuration_map_dto.py +96 -0
  303. visier_platform_sdk/models/designer_api_calculation_concept_dto.py +96 -0
  304. visier_platform_sdk/models/designer_api_calculation_concept_list_dto.py +96 -0
  305. visier_platform_sdk/models/designer_api_concept_configuration_result_dto.py +92 -0
  306. visier_platform_sdk/models/designer_api_dimension_filter_dto.py +100 -0
  307. visier_platform_sdk/models/designer_api_dimension_member_dto.py +88 -0
  308. visier_platform_sdk/models/designer_api_perspective_configuration_dto.py +100 -0
  309. visier_platform_sdk/models/designer_api_perspective_node_dto.py +100 -0
  310. visier_platform_sdk/models/designer_api_selection_concept_configuration_dto.py +96 -0
  311. visier_platform_sdk/models/designer_api_selection_concept_configuration_map_dto.py +96 -0
  312. visier_platform_sdk/models/designer_api_selection_concept_dto.py +96 -0
  313. visier_platform_sdk/models/designer_api_selection_concept_list_dto.py +96 -0
  314. visier_platform_sdk/models/designer_bamboo_auth_params_dto.py +90 -0
  315. visier_platform_sdk/models/designer_basic_s3_auth_params_dto.py +96 -0
  316. visier_platform_sdk/models/designer_big_query_auth_params_dto.py +104 -0
  317. visier_platform_sdk/models/designer_big_query_service_account_params_dto.py +90 -0
  318. visier_platform_sdk/models/designer_copy_s3_auth_params_dto.py +88 -0
  319. visier_platform_sdk/models/designer_credential_creation_api_response_dto.py +102 -0
  320. visier_platform_sdk/models/designer_crypto_generate_key_request_dto.py +92 -0
  321. visier_platform_sdk/models/designer_crypto_key_pair_delete_response_dto.py +88 -0
  322. visier_platform_sdk/models/designer_crypto_key_pair_generate_request_dto.py +88 -0
  323. visier_platform_sdk/models/designer_crypto_public_key_dto.py +96 -0
  324. visier_platform_sdk/models/designer_crypto_public_keys_dto.py +96 -0
  325. visier_platform_sdk/models/designer_crypto_tenant_encryption_key_details_dto.py +96 -0
  326. visier_platform_sdk/models/designer_crypto_tenant_encryption_key_dto.py +94 -0
  327. visier_platform_sdk/models/designer_data_provider_auth_information_dto.py +104 -0
  328. visier_platform_sdk/models/designer_data_provider_auth_params_dto.py +344 -0
  329. visier_platform_sdk/models/designer_data_provider_basic_information_dto.py +90 -0
  330. visier_platform_sdk/models/designer_data_provider_basic_metadata_dto.py +88 -0
  331. visier_platform_sdk/models/designer_data_version_export_column_dto.py +94 -0
  332. visier_platform_sdk/models/designer_data_version_export_data_version_summary_dto.py +92 -0
  333. visier_platform_sdk/models/designer_data_version_export_data_versions_dto.py +96 -0
  334. visier_platform_sdk/models/designer_data_version_export_dto.py +108 -0
  335. visier_platform_sdk/models/designer_data_version_export_file_dto.py +106 -0
  336. visier_platform_sdk/models/designer_data_version_export_job_status_dto.py +94 -0
  337. visier_platform_sdk/models/designer_data_version_export_part_file_dto.py +90 -0
  338. visier_platform_sdk/models/designer_data_version_export_schedule_job_request_dto.py +90 -0
  339. visier_platform_sdk/models/designer_data_version_export_schedule_job_response_dto.py +88 -0
  340. visier_platform_sdk/models/designer_data_version_export_table_dto.py +101 -0
  341. visier_platform_sdk/models/designer_data_version_exports_dto.py +96 -0
  342. visier_platform_sdk/models/designer_databricks_auth_params_dto.py +94 -0
  343. visier_platform_sdk/models/designer_dayforce_v2_auth_params_dto.py +96 -0
  344. visier_platform_sdk/models/designer_dimensions_auth_params_dto.py +98 -0
  345. visier_platform_sdk/models/designer_download_source_files_dto.py +102 -0
  346. visier_platform_sdk/models/designer_download_source_files_response_dto.py +90 -0
  347. visier_platform_sdk/models/designer_extractor_credential_apidto.py +96 -0
  348. visier_platform_sdk/models/designer_extractor_credentials_apidto.py +100 -0
  349. visier_platform_sdk/models/designer_fusion_auth_params_dto.py +92 -0
  350. visier_platform_sdk/models/designer_gong_auth_params_dto.py +90 -0
  351. visier_platform_sdk/models/designer_google_sheets_auth_params_dto.py +94 -0
  352. visier_platform_sdk/models/designer_google_workspace_auth_params_dto.py +96 -0
  353. visier_platform_sdk/models/designer_greenhouse_auth_params_dto.py +88 -0
  354. visier_platform_sdk/models/designer_icims_auth_params_dto.py +108 -0
  355. visier_platform_sdk/models/designer_internal_s3_auth_params_dto.py +90 -0
  356. visier_platform_sdk/models/designer_jdbc_auth_params_dto.py +92 -0
  357. visier_platform_sdk/models/designer_jira_auth_params_dto.py +96 -0
  358. visier_platform_sdk/models/designer_jira_connect_params_dto.py +92 -0
  359. visier_platform_sdk/models/designer_lever_auth_params_dto.py +88 -0
  360. visier_platform_sdk/models/designer_medallia_auth_params_dto.py +94 -0
  361. visier_platform_sdk/models/designer_microsoft365_auth_params_dto.py +94 -0
  362. visier_platform_sdk/models/designer_module_settings_dto.py +92 -0
  363. visier_platform_sdk/models/designer_my_sql_auth_params_dto.py +98 -0
  364. visier_platform_sdk/models/designer_namely_auth_params_dto.py +88 -0
  365. visier_platform_sdk/models/designer_oracle_db_auth_params_dto.py +96 -0
  366. visier_platform_sdk/models/designer_push_data_column_definition_dto.py +98 -0
  367. visier_platform_sdk/models/designer_push_data_source_definition_dto.py +102 -0
  368. visier_platform_sdk/models/designer_push_data_source_definitions_dto.py +96 -0
  369. visier_platform_sdk/models/designer_qualtrics_auth_params_dto.py +90 -0
  370. visier_platform_sdk/models/designer_redshift_auth_params_dto.py +100 -0
  371. visier_platform_sdk/models/designer_salesforce_auth_params_dto.py +90 -0
  372. visier_platform_sdk/models/designer_salesforce_v2_auth_params_dto.py +94 -0
  373. visier_platform_sdk/models/designer_service_now_auth_params_dto.py +92 -0
  374. visier_platform_sdk/models/designer_service_now_v2_auth_params_dto.py +96 -0
  375. visier_platform_sdk/models/designer_slack_auth_params_dto.py +92 -0
  376. visier_platform_sdk/models/designer_snowflake_auth_params_dto.py +100 -0
  377. visier_platform_sdk/models/designer_sql_server_auth_params_dto.py +96 -0
  378. visier_platform_sdk/models/designer_subject_missing_access_dto.py +102 -0
  379. visier_platform_sdk/models/designer_success_factors_auth_params_dto.py +100 -0
  380. visier_platform_sdk/models/designer_success_factors_o_auth_params_dto.py +92 -0
  381. visier_platform_sdk/models/designer_tenant_module_dto.py +96 -0
  382. visier_platform_sdk/models/designer_ultimate_auth_params_dto.py +96 -0
  383. visier_platform_sdk/models/designer_webhook_webhook_basic_auth_credential_dto.py +90 -0
  384. visier_platform_sdk/models/designer_webhook_webhook_credentials_dto.py +94 -0
  385. visier_platform_sdk/models/designer_webhook_webhook_details_dto.py +104 -0
  386. visier_platform_sdk/models/designer_webhook_webhook_dto.py +96 -0
  387. visier_platform_sdk/models/designer_webhook_webhook_event_type_dto.py +88 -0
  388. visier_platform_sdk/models/designer_webhook_webhook_message_response_dto.py +94 -0
  389. visier_platform_sdk/models/designer_webhook_webhook_request_dto.py +98 -0
  390. visier_platform_sdk/models/designer_webhook_webhooks_dto.py +96 -0
  391. visier_platform_sdk/models/designer_willow_auth_params_dto.py +90 -0
  392. visier_platform_sdk/models/designer_workday_auth_params_dto.py +110 -0
  393. visier_platform_sdk/models/designer_workday_o_auth_params_dto.py +92 -0
  394. visier_platform_sdk/models/designer_workday_raas_auth_params_dto.py +96 -0
  395. visier_platform_sdk/models/designer_workday_refresh_token_params_dto.py +92 -0
  396. visier_platform_sdk/models/designer_zoom_auth_params_dto.py +92 -0
  397. visier_platform_sdk/models/dimension_member.py +139 -0
  398. visier_platform_sdk/models/direct_data_upload_file_response_dto.py +92 -0
  399. visier_platform_sdk/models/dp_automation_metric_validation_summary_dto.py +92 -0
  400. visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_dto.py +102 -0
  401. visier_platform_sdk/models/dp_automation_tenant_preview_entries_summary_list_dto.py +100 -0
  402. visier_platform_sdk/models/dp_cancel_job_batch_from_job_id_dto.py +88 -0
  403. visier_platform_sdk/models/dp_job_cancellation_result_dto.py +110 -0
  404. visier_platform_sdk/models/dp_job_cancellation_results_dto.py +96 -0
  405. visier_platform_sdk/models/dv_export_status.py +96 -0
  406. visier_platform_sdk/models/extracted_skill.py +94 -0
  407. visier_platform_sdk/models/generate_impersonation_token_request.py +88 -0
  408. visier_platform_sdk/models/google_protobuf_any.py +101 -0
  409. visier_platform_sdk/models/hierarchy.py +92 -0
  410. visier_platform_sdk/models/job.py +121 -0
  411. visier_platform_sdk/models/job_entry.py +92 -0
  412. visier_platform_sdk/models/job_feedback_input.py +92 -0
  413. visier_platform_sdk/models/job_search_failure_output.py +94 -0
  414. visier_platform_sdk/models/job_search_input.py +88 -0
  415. visier_platform_sdk/models/job_search_output.py +106 -0
  416. visier_platform_sdk/models/job_standardization_input.py +98 -0
  417. visier_platform_sdk/models/job_standardization_input_skills.py +90 -0
  418. visier_platform_sdk/models/location_search_failure_output.py +96 -0
  419. visier_platform_sdk/models/location_search_input.py +98 -0
  420. visier_platform_sdk/models/location_search_input1.py +92 -0
  421. visier_platform_sdk/models/location_search_output.py +106 -0
  422. visier_platform_sdk/models/location_search_successful_output.py +98 -0
  423. visier_platform_sdk/models/output_entry.py +98 -0
  424. visier_platform_sdk/models/output_entry1.py +98 -0
  425. visier_platform_sdk/models/output_entry1_matches_inner.py +94 -0
  426. visier_platform_sdk/models/plan_data_load_change_dto.py +94 -0
  427. visier_platform_sdk/models/plan_data_load_change_list_dto.py +98 -0
  428. visier_platform_sdk/models/plan_data_upload_response_dto.py +110 -0
  429. visier_platform_sdk/models/plan_row_data_load_response_dto.py +114 -0
  430. visier_platform_sdk/models/planning_get_plan_list_response_dto.py +98 -0
  431. visier_platform_sdk/models/planning_plan_data_load_error_dto.py +92 -0
  432. visier_platform_sdk/models/planning_plan_info_dto.py +106 -0
  433. visier_platform_sdk/models/planning_plan_item_dto.py +102 -0
  434. visier_platform_sdk/models/planning_plan_schema_dto.py +126 -0
  435. visier_platform_sdk/models/planning_plan_segment_level_dto.py +96 -0
  436. visier_platform_sdk/models/planning_plan_segment_level_member_dto.py +94 -0
  437. visier_platform_sdk/models/planning_plan_segment_level_member_list_dto.py +100 -0
  438. visier_platform_sdk/models/planning_plan_time_period_dto.py +90 -0
  439. visier_platform_sdk/models/planning_plan_with_schema_dto.py +108 -0
  440. visier_platform_sdk/models/planning_scenario_info_dto.py +92 -0
  441. visier_platform_sdk/models/salary_benchmark_input.py +100 -0
  442. visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py +96 -0
  443. visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py +106 -0
  444. visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py +110 -0
  445. visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_request_dto.py +102 -0
  446. visier_platform_sdk/models/servicing_accessible_tenant_profile_assignment_response_dto.py +128 -0
  447. visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_request_dto.py +98 -0
  448. visier_platform_sdk/models/servicing_accessible_tenant_profile_revoke_response_dto.py +125 -0
  449. visier_platform_sdk/models/servicing_additional_capabilities_dto.py +88 -0
  450. visier_platform_sdk/models/servicing_admin_capability_config_dto.py +90 -0
  451. visier_platform_sdk/models/servicing_all_permissions_assigned_for_local_tenant_dto.py +96 -0
  452. visier_platform_sdk/models/servicing_all_profile_assigned_for_accessible_tenant_dto.py +96 -0
  453. visier_platform_sdk/models/servicing_all_profile_assigned_for_local_tenant_dto.py +96 -0
  454. visier_platform_sdk/models/servicing_all_user_groups_assigned_for_local_tenant_dto.py +96 -0
  455. visier_platform_sdk/models/servicing_all_users_get_api_response_dto.py +100 -0
  456. visier_platform_sdk/models/servicing_analytic_object_dto.py +132 -0
  457. visier_platform_sdk/models/servicing_assign_revoke_permission_by_permission_dto.py +102 -0
  458. visier_platform_sdk/models/servicing_assign_revoke_permission_by_tenant_dto.py +114 -0
  459. visier_platform_sdk/models/servicing_assign_revoke_permission_by_user_dto.py +92 -0
  460. visier_platform_sdk/models/servicing_assign_revoke_permission_request_dto.py +90 -0
  461. visier_platform_sdk/models/servicing_assign_revoke_permissions_request_dto.py +102 -0
  462. visier_platform_sdk/models/servicing_assign_revoke_permissions_response_dto.py +96 -0
  463. visier_platform_sdk/models/servicing_bulk_data_access_set_response_dto.py +106 -0
  464. visier_platform_sdk/models/servicing_capabilities_dto.py +92 -0
  465. visier_platform_sdk/models/servicing_capability_dto.py +92 -0
  466. visier_platform_sdk/models/servicing_capability_group_dto.py +146 -0
  467. visier_platform_sdk/models/servicing_commit_and_publish_operation_response_dto.py +92 -0
  468. visier_platform_sdk/models/servicing_commit_dto.py +92 -0
  469. visier_platform_sdk/models/servicing_content_package_dto.py +92 -0
  470. visier_platform_sdk/models/servicing_create_data_access_set_request_dto.py +96 -0
  471. visier_platform_sdk/models/servicing_data_access_set_dto.py +104 -0
  472. visier_platform_sdk/models/servicing_data_access_set_error_dto.py +90 -0
  473. visier_platform_sdk/models/servicing_data_access_set_failure_dto.py +96 -0
  474. visier_platform_sdk/models/servicing_data_access_set_success_dto.py +90 -0
  475. visier_platform_sdk/models/servicing_data_categories_response_dto.py +96 -0
  476. visier_platform_sdk/models/servicing_data_category_response_dto.py +90 -0
  477. visier_platform_sdk/models/servicing_data_security_profile_dto.py +134 -0
  478. visier_platform_sdk/models/servicing_delete_permissions_request_dto.py +88 -0
  479. visier_platform_sdk/models/servicing_dimension_filter_dto.py +98 -0
  480. visier_platform_sdk/models/servicing_direct_data_job_config_dto.py +100 -0
  481. visier_platform_sdk/models/servicing_direct_data_job_status_response_dto.py +96 -0
  482. visier_platform_sdk/models/servicing_direct_data_list_transactions_response_dto.py +96 -0
  483. visier_platform_sdk/models/servicing_direct_data_load_config_dto.py +92 -0
  484. visier_platform_sdk/models/servicing_direct_data_schema_dto.py +96 -0
  485. visier_platform_sdk/models/servicing_direct_data_schema_field_dto.py +96 -0
  486. visier_platform_sdk/models/servicing_direct_data_transaction_dto.py +96 -0
  487. visier_platform_sdk/models/servicing_direct_data_transaction_start_response_dto.py +88 -0
  488. visier_platform_sdk/models/servicing_direct_data_upload_file_response_dto.py +92 -0
  489. visier_platform_sdk/models/servicing_document_search_link_dto.py +90 -0
  490. visier_platform_sdk/models/servicing_dynamic_dimension_filter_dto.py +112 -0
  491. visier_platform_sdk/models/servicing_dynamic_property_mapping_dto.py +106 -0
  492. visier_platform_sdk/models/servicing_error_dto.py +92 -0
  493. visier_platform_sdk/models/servicing_export_production_versions_api_operation_parameters_dto.py +92 -0
  494. visier_platform_sdk/models/servicing_failed_accessible_tenant_profile_assignment_dto.py +98 -0
  495. visier_platform_sdk/models/servicing_failed_local_tenant_profile_assignment_dto.py +94 -0
  496. visier_platform_sdk/models/servicing_failed_local_tenant_profile_revoke_dto.py +90 -0
  497. visier_platform_sdk/models/servicing_get_capabilities_api_response_dto.py +96 -0
  498. visier_platform_sdk/models/servicing_get_content_packages_api_response_dto.py +96 -0
  499. visier_platform_sdk/models/servicing_get_data_access_sets_api_response_dto.py +96 -0
  500. visier_platform_sdk/models/servicing_get_data_security_objects_api_response_dto.py +96 -0
  501. visier_platform_sdk/models/servicing_get_permissions_api_response_dto.py +96 -0
  502. visier_platform_sdk/models/servicing_get_production_versions_api_response_dto.py +96 -0
  503. visier_platform_sdk/models/servicing_get_projects_api_response_dto.py +123 -0
  504. visier_platform_sdk/models/servicing_hierarchy_property_dto.py +90 -0
  505. visier_platform_sdk/models/servicing_inherited_access_config_dto.py +100 -0
  506. visier_platform_sdk/models/servicing_inherited_reference_member_filter_config_dto.py +90 -0
  507. visier_platform_sdk/models/servicing_job_id_response.py +88 -0
  508. visier_platform_sdk/models/servicing_last_login_dto.py +88 -0
  509. visier_platform_sdk/models/servicing_local_tenant_profile_assignment_request_dto.py +92 -0
  510. visier_platform_sdk/models/servicing_local_tenant_profile_assignment_response_dto.py +118 -0
  511. visier_platform_sdk/models/servicing_local_tenant_profile_revoke_request_dto.py +88 -0
  512. visier_platform_sdk/models/servicing_local_tenant_profile_revoke_response_dto.py +106 -0
  513. visier_platform_sdk/models/servicing_member_filter_config_dto.py +96 -0
  514. visier_platform_sdk/models/servicing_member_selection_dto.py +102 -0
  515. visier_platform_sdk/models/servicing_objectconfiguration_calculated_property_type_dto.py +90 -0
  516. visier_platform_sdk/models/servicing_objectconfiguration_dependent_dto.py +92 -0
  517. visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definition_dto.py +94 -0
  518. visier_platform_sdk/models/servicing_objectconfiguration_dimension_change_definitions_by_tenant_dto.py +100 -0
  519. visier_platform_sdk/models/servicing_objectconfiguration_dimensions_change_definitions_dto.py +96 -0
  520. visier_platform_sdk/models/servicing_objectconfiguration_object_change_failure_dto.py +98 -0
  521. visier_platform_sdk/models/servicing_objectconfiguration_object_change_success_dto.py +94 -0
  522. visier_platform_sdk/models/servicing_objectconfiguration_objects_bulk_change_response_dto.py +106 -0
  523. visier_platform_sdk/models/servicing_objectconfiguration_properties_change_definitions_dto.py +96 -0
  524. visier_platform_sdk/models/servicing_objectconfiguration_properties_delete_definitions_dto.py +100 -0
  525. visier_platform_sdk/models/servicing_objectconfiguration_property_bulk_delete_response_dto.py +106 -0
  526. visier_platform_sdk/models/servicing_objectconfiguration_property_change_definition_dto.py +112 -0
  527. visier_platform_sdk/models/servicing_objectconfiguration_property_change_definitions_by_tenant_dto.py +100 -0
  528. visier_platform_sdk/models/servicing_objectconfiguration_property_delete_definitions_by_tenant_dto.py +92 -0
  529. visier_platform_sdk/models/servicing_objectconfiguration_property_delete_failure_dto.py +117 -0
  530. visier_platform_sdk/models/servicing_objectconfiguration_property_delete_success_dto.py +113 -0
  531. visier_platform_sdk/models/servicing_objectconfiguration_property_type_dto.py +98 -0
  532. visier_platform_sdk/models/servicing_objectconfiguration_simple_property_type_dto.py +88 -0
  533. visier_platform_sdk/models/servicing_objectconfiguration_tags_dto.py +88 -0
  534. visier_platform_sdk/models/servicing_permission_assigned_by_tenant_dto.py +98 -0
  535. visier_platform_sdk/models/servicing_permission_assigned_for_local_tenant_dto.py +92 -0
  536. visier_platform_sdk/models/servicing_permission_assigned_user_dto.py +92 -0
  537. visier_platform_sdk/models/servicing_permission_assigned_users_dto.py +100 -0
  538. visier_platform_sdk/models/servicing_permission_bulk_operation_response_dto.py +106 -0
  539. visier_platform_sdk/models/servicing_permission_dto.py +114 -0
  540. visier_platform_sdk/models/servicing_permission_error_dto.py +90 -0
  541. visier_platform_sdk/models/servicing_permission_failure_dto.py +96 -0
  542. visier_platform_sdk/models/servicing_permission_success_dto.py +90 -0
  543. visier_platform_sdk/models/servicing_production_version_api_operation_request_dto.py +98 -0
  544. visier_platform_sdk/models/servicing_production_version_api_operation_response_dto.py +92 -0
  545. visier_platform_sdk/models/servicing_production_versions_api_operation_request_dto.py +104 -0
  546. visier_platform_sdk/models/servicing_production_versions_api_operation_response_dto.py +88 -0
  547. visier_platform_sdk/models/servicing_profile_assigned_for_accessible_tenant_dto.py +98 -0
  548. visier_platform_sdk/models/servicing_profile_assigned_for_local_tenant_dto.py +110 -0
  549. visier_platform_sdk/models/servicing_profile_get_api_response_dto.py +102 -0
  550. visier_platform_sdk/models/servicing_profiles_get_api_response_dto.py +96 -0
  551. visier_platform_sdk/models/servicing_project_commits_api_response_dto.py +96 -0
  552. visier_platform_sdk/models/servicing_project_dto.py +111 -0
  553. visier_platform_sdk/models/servicing_project_operation_request_dto.py +98 -0
  554. visier_platform_sdk/models/servicing_project_operation_response_dto.py +92 -0
  555. visier_platform_sdk/models/servicing_property_access_config_dto.py +116 -0
  556. visier_platform_sdk/models/servicing_property_set_config_dto.py +102 -0
  557. visier_platform_sdk/models/servicing_question_categories_api_response_dto.py +96 -0
  558. visier_platform_sdk/models/servicing_question_category_api_response_dto.py +90 -0
  559. visier_platform_sdk/models/servicing_reduced_error_dto.py +88 -0
  560. visier_platform_sdk/models/servicing_reduced_tenant_code_error_dto.py +96 -0
  561. visier_platform_sdk/models/servicing_reduced_user_id_error_dto.py +94 -0
  562. visier_platform_sdk/models/servicing_related_analytic_object_dto.py +90 -0
  563. visier_platform_sdk/models/servicing_role_modules_config_dto.py +88 -0
  564. visier_platform_sdk/models/servicing_sample_question_api_response_dto.py +100 -0
  565. visier_platform_sdk/models/servicing_sample_questions_api_response_dto.py +96 -0
  566. visier_platform_sdk/models/servicing_securable_dimension_dto.py +102 -0
  567. visier_platform_sdk/models/servicing_securable_property_dto.py +96 -0
  568. visier_platform_sdk/models/servicing_servicing_capability_proto_enum_access_lookup_dto.py +96 -0
  569. visier_platform_sdk/models/servicing_shareable_data_access_set.py +88 -0
  570. visier_platform_sdk/models/servicing_simple_document_header_search_response_dto.py +96 -0
  571. visier_platform_sdk/models/servicing_simple_document_header_search_result_dto.py +98 -0
  572. visier_platform_sdk/models/servicing_sources_api_operation_request_dto.py +98 -0
  573. visier_platform_sdk/models/servicing_static_dimension_filter_dto.py +112 -0
  574. visier_platform_sdk/models/servicing_successful_accessible_tenant_profile_assignment_dto.py +92 -0
  575. visier_platform_sdk/models/servicing_successful_local_tenant_profile_assignment_dto.py +88 -0
  576. visier_platform_sdk/models/servicing_target_tenant_code_dto.py +90 -0
  577. visier_platform_sdk/models/servicing_tenant_code_error_dto.py +96 -0
  578. visier_platform_sdk/models/servicing_tenant_data_upload_status_response_dto.py +90 -0
  579. visier_platform_sdk/models/servicing_tenant_data_upload_update_status_response_dto.py +94 -0
  580. visier_platform_sdk/models/servicing_tenant_data_uploads_list_response_dto.py +100 -0
  581. visier_platform_sdk/models/servicing_tenant_data_uploads_response_dto.py +98 -0
  582. visier_platform_sdk/models/servicing_tenant_data_uploads_update_response_dto.py +100 -0
  583. visier_platform_sdk/models/servicing_user_creation_api_request_dto.py +96 -0
  584. visier_platform_sdk/models/servicing_user_get_api_response_dto.py +122 -0
  585. visier_platform_sdk/models/servicing_user_group_assigned_for_local_tenant_dto.py +90 -0
  586. visier_platform_sdk/models/servicing_user_group_assignment_dto.py +88 -0
  587. visier_platform_sdk/models/servicing_user_id_error_dto.py +94 -0
  588. visier_platform_sdk/models/servicing_user_property_dto.py +88 -0
  589. visier_platform_sdk/models/servicing_user_update_api_request_dto.py +96 -0
  590. visier_platform_sdk/models/servicing_users_api_error_message_dto.py +90 -0
  591. visier_platform_sdk/models/servicing_users_api_failure_dto.py +98 -0
  592. visier_platform_sdk/models/servicing_users_api_response_dto.py +106 -0
  593. visier_platform_sdk/models/servicing_users_api_success_dto.py +98 -0
  594. visier_platform_sdk/models/servicing_users_creation_api_request_dto.py +96 -0
  595. visier_platform_sdk/models/servicing_users_delete_api_request_dto.py +88 -0
  596. visier_platform_sdk/models/servicing_users_update_api_request_dto.py +96 -0
  597. visier_platform_sdk/models/servicing_users_update_api_user_dto.py +98 -0
  598. visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_definition_dto.py +102 -0
  599. visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_request_dto.py +96 -0
  600. visier_platform_sdk/models/servicing_v2_objectconfiguration_analytic_object_with_context_dto.py +98 -0
  601. visier_platform_sdk/models/servicing_v2_objectconfiguration_basic_information_dto.py +102 -0
  602. visier_platform_sdk/models/servicing_v2_objectconfiguration_bulk_change_response_dto.py +106 -0
  603. visier_platform_sdk/models/servicing_v2_objectconfiguration_calculated_property_type_dto.py +92 -0
  604. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_definition_dto.py +102 -0
  605. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_request_dto.py +96 -0
  606. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_delete_with_context_dto.py +98 -0
  607. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_request_dto.py +96 -0
  608. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_response_dto.py +96 -0
  609. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_type_details_dto.py +92 -0
  610. visier_platform_sdk/models/servicing_v2_objectconfiguration_concept_with_context_dto.py +98 -0
  611. visier_platform_sdk/models/servicing_v2_objectconfiguration_execution_context_dto.py +90 -0
  612. visier_platform_sdk/models/servicing_v2_objectconfiguration_failed_change_dto.py +100 -0
  613. visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_definition_dto.py +114 -0
  614. visier_platform_sdk/models/servicing_v2_objectconfiguration_metric_type_details_dto.py +92 -0
  615. visier_platform_sdk/models/servicing_v2_objectconfiguration_object_id_dto.py +90 -0
  616. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_definition_dto.py +128 -0
  617. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_dto.py +90 -0
  618. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_member_list_dto.py +96 -0
  619. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_definition_dto.py +92 -0
  620. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_metric_list_dto.py +96 -0
  621. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_dto.py +114 -0
  622. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_outcome_list_dto.py +96 -0
  623. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_list_dto.py +96 -0
  624. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_property_type_dto.py +92 -0
  625. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_dto.py +102 -0
  626. visier_platform_sdk/models/servicing_v2_objectconfiguration_process_concept_stage_list_dto.py +96 -0
  627. visier_platform_sdk/models/servicing_v2_objectconfiguration_property_definition_dto.py +102 -0
  628. visier_platform_sdk/models/servicing_v2_objectconfiguration_property_type_details_dto.py +104 -0
  629. visier_platform_sdk/models/servicing_v2_objectconfiguration_simple_property_type_dto.py +90 -0
  630. visier_platform_sdk/models/servicing_v2_objectconfiguration_successful_change_dto.py +98 -0
  631. visier_platform_sdk/models/servicing_v2_objectconfiguration_synonym_list_dto.py +88 -0
  632. visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_dto.py +88 -0
  633. visier_platform_sdk/models/servicing_v2_objectconfiguration_tag_reference_list_dto.py +96 -0
  634. visier_platform_sdk/models/servicing_vee_question_change_definition_dto.py +100 -0
  635. visier_platform_sdk/models/servicing_vee_question_change_definitions_by_tenant_dto.py +100 -0
  636. visier_platform_sdk/models/servicing_vee_question_change_failure_dto.py +106 -0
  637. visier_platform_sdk/models/servicing_vee_question_change_success_dto.py +104 -0
  638. visier_platform_sdk/models/servicing_vee_question_delete_definitions_by_tenant_dto.py +92 -0
  639. visier_platform_sdk/models/servicing_vee_questions_bulk_change_response_dto.py +106 -0
  640. visier_platform_sdk/models/servicing_vee_questions_change_definitions_dto.py +96 -0
  641. visier_platform_sdk/models/servicing_vee_questions_delete_definitions_dto.py +96 -0
  642. visier_platform_sdk/models/skill.py +106 -0
  643. visier_platform_sdk/models/skill_category.py +102 -0
  644. visier_platform_sdk/models/skill_category_entry.py +92 -0
  645. visier_platform_sdk/models/skill_entry.py +92 -0
  646. visier_platform_sdk/models/skill_extraction_input.py +93 -0
  647. visier_platform_sdk/models/skill_group.py +104 -0
  648. visier_platform_sdk/models/skill_group_entry.py +92 -0
  649. visier_platform_sdk/models/skill_match_input.py +91 -0
  650. visier_platform_sdk/models/source_import_result_summary_dto.py +94 -0
  651. visier_platform_sdk/models/sources_api_put_response_dto.py +92 -0
  652. visier_platform_sdk/models/sql_like200_response.py +138 -0
  653. visier_platform_sdk/models/status.py +96 -0
  654. visier_platform_sdk/models/systemstatus_system_status_dto.py +88 -0
  655. visier_platform_sdk/models/systemstatus_vee_status_dto.py +88 -0
  656. visier_platform_sdk/models/table_response_dto.py +90 -0
  657. visier_platform_sdk/models/token_response.py +96 -0
  658. visier_platform_sdk/models/user_creation_api_response_dto.py +98 -0
  659. visier_platform_sdk/py.typed +0 -0
  660. visier_platform_sdk/rest.py +259 -0
  661. visier_platform_sdk-22222222.99201.1892b3.dist-info/METADATA +25 -0
  662. visier_platform_sdk-22222222.99201.1892b3.dist-info/RECORD +664 -0
  663. visier_platform_sdk-22222222.99201.1892b3.dist-info/WHEEL +5 -0
  664. visier_platform_sdk-22222222.99201.1892b3.dist-info/top_level.txt +1 -0
@@ -0,0 +1,2281 @@
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.99201.1892
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, StrictBool, StrictStr
21
+ from typing import Optional
22
+ from typing_extensions import Annotated
23
+ from visier_platform_sdk.models.designer_webhook_webhook_credentials_dto import DesignerWebhookWebhookCredentialsDTO
24
+ from visier_platform_sdk.models.designer_webhook_webhook_dto import DesignerWebhookWebhookDTO
25
+ from visier_platform_sdk.models.designer_webhook_webhook_event_type_dto import DesignerWebhookWebhookEventTypeDTO
26
+ from visier_platform_sdk.models.designer_webhook_webhook_message_response_dto import DesignerWebhookWebhookMessageResponseDTO
27
+ from visier_platform_sdk.models.designer_webhook_webhook_request_dto import DesignerWebhookWebhookRequestDTO
28
+ from visier_platform_sdk.models.designer_webhook_webhooks_dto import DesignerWebhookWebhooksDTO
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 WebhooksApi:
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 create_webhook(
50
+ self,
51
+ designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO,
52
+ _request_timeout: Union[
53
+ None,
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Tuple[
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Annotated[StrictFloat, Field(gt=0)]
58
+ ]
59
+ ] = None,
60
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
61
+ _content_type: Optional[StrictStr] = None,
62
+ _headers: Optional[Dict[StrictStr, Any]] = None,
63
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
64
+ ) -> DesignerWebhookWebhookDTO:
65
+ """Create a webhook
66
+
67
+ Create a new webhook with Visier. You must specify the webhook's endpoint URL, its active status, the event types to listen for, and the credentials to authenticate calls to the webhook endpoint. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
68
+
69
+ :param designer_webhook_webhook_request_dto: (required)
70
+ :type designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO
71
+ :param _request_timeout: timeout setting for this request. If one
72
+ number provided, it will be total request
73
+ timeout. It can also be a pair (tuple) of
74
+ (connection, read) timeouts.
75
+ :type _request_timeout: int, tuple(int, int), optional
76
+ :param _request_auth: set to override the auth_settings for an a single
77
+ request; this effectively ignores the
78
+ authentication in the spec for a single request.
79
+ :type _request_auth: dict, optional
80
+ :param _content_type: force content-type for the request.
81
+ :type _content_type: str, Optional
82
+ :param _headers: set to override the headers for a single
83
+ request; this effectively ignores the headers
84
+ in the spec for a single request.
85
+ :type _headers: dict, optional
86
+ :param _host_index: set to override the host_index for a single
87
+ request; this effectively ignores the host_index
88
+ in the spec for a single request.
89
+ :type _host_index: int, optional
90
+ :return: Returns the result object.
91
+ """ # noqa: E501
92
+
93
+ _param = self._create_webhook_serialize(
94
+ designer_webhook_webhook_request_dto=designer_webhook_webhook_request_dto,
95
+ _request_auth=_request_auth,
96
+ _content_type=_content_type,
97
+ _headers=_headers,
98
+ _host_index=_host_index
99
+ )
100
+
101
+ _response_types_map: Dict[str, Optional[str]] = {
102
+ '200': "DesignerWebhookWebhookDTO",
103
+ }
104
+ response_data = self.api_client.call_api(
105
+ *_param,
106
+ _request_timeout=_request_timeout
107
+ )
108
+ response_data.read()
109
+ return self.api_client.response_deserialize(
110
+ response_data=response_data,
111
+ response_types_map=_response_types_map,
112
+ ).data
113
+
114
+
115
+ @validate_call
116
+ def create_webhook_with_http_info(
117
+ self,
118
+ designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO,
119
+ _request_timeout: Union[
120
+ None,
121
+ Annotated[StrictFloat, Field(gt=0)],
122
+ Tuple[
123
+ Annotated[StrictFloat, Field(gt=0)],
124
+ Annotated[StrictFloat, Field(gt=0)]
125
+ ]
126
+ ] = None,
127
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
128
+ _content_type: Optional[StrictStr] = None,
129
+ _headers: Optional[Dict[StrictStr, Any]] = None,
130
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
131
+ ) -> ApiResponse[DesignerWebhookWebhookDTO]:
132
+ """Create a webhook
133
+
134
+ Create a new webhook with Visier. You must specify the webhook's endpoint URL, its active status, the event types to listen for, and the credentials to authenticate calls to the webhook endpoint. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
135
+
136
+ :param designer_webhook_webhook_request_dto: (required)
137
+ :type designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO
138
+ :param _request_timeout: timeout setting for this request. If one
139
+ number provided, it will be total request
140
+ timeout. It can also be a pair (tuple) of
141
+ (connection, read) timeouts.
142
+ :type _request_timeout: int, tuple(int, int), optional
143
+ :param _request_auth: set to override the auth_settings for an a single
144
+ request; this effectively ignores the
145
+ authentication in the spec for a single request.
146
+ :type _request_auth: dict, optional
147
+ :param _content_type: force content-type for the request.
148
+ :type _content_type: str, Optional
149
+ :param _headers: set to override the headers for a single
150
+ request; this effectively ignores the headers
151
+ in the spec for a single request.
152
+ :type _headers: dict, optional
153
+ :param _host_index: set to override the host_index for a single
154
+ request; this effectively ignores the host_index
155
+ in the spec for a single request.
156
+ :type _host_index: int, optional
157
+ :return: Returns the result object.
158
+ """ # noqa: E501
159
+
160
+ _param = self._create_webhook_serialize(
161
+ designer_webhook_webhook_request_dto=designer_webhook_webhook_request_dto,
162
+ _request_auth=_request_auth,
163
+ _content_type=_content_type,
164
+ _headers=_headers,
165
+ _host_index=_host_index
166
+ )
167
+
168
+ _response_types_map: Dict[str, Optional[str]] = {
169
+ '200': "DesignerWebhookWebhookDTO",
170
+ }
171
+ response_data = self.api_client.call_api(
172
+ *_param,
173
+ _request_timeout=_request_timeout
174
+ )
175
+ response_data.read()
176
+ return self.api_client.response_deserialize(
177
+ response_data=response_data,
178
+ response_types_map=_response_types_map,
179
+ )
180
+
181
+
182
+ @validate_call
183
+ def create_webhook_without_preload_content(
184
+ self,
185
+ designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO,
186
+ _request_timeout: Union[
187
+ None,
188
+ Annotated[StrictFloat, Field(gt=0)],
189
+ Tuple[
190
+ Annotated[StrictFloat, Field(gt=0)],
191
+ Annotated[StrictFloat, Field(gt=0)]
192
+ ]
193
+ ] = None,
194
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
195
+ _content_type: Optional[StrictStr] = None,
196
+ _headers: Optional[Dict[StrictStr, Any]] = None,
197
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
198
+ ) -> RESTResponseType:
199
+ """Create a webhook
200
+
201
+ Create a new webhook with Visier. You must specify the webhook's endpoint URL, its active status, the event types to listen for, and the credentials to authenticate calls to the webhook endpoint. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
202
+
203
+ :param designer_webhook_webhook_request_dto: (required)
204
+ :type designer_webhook_webhook_request_dto: DesignerWebhookWebhookRequestDTO
205
+ :param _request_timeout: timeout setting for this request. If one
206
+ number provided, it will be total request
207
+ timeout. It can also be a pair (tuple) of
208
+ (connection, read) timeouts.
209
+ :type _request_timeout: int, tuple(int, int), optional
210
+ :param _request_auth: set to override the auth_settings for an a single
211
+ request; this effectively ignores the
212
+ authentication in the spec for a single request.
213
+ :type _request_auth: dict, optional
214
+ :param _content_type: force content-type for the request.
215
+ :type _content_type: str, Optional
216
+ :param _headers: set to override the headers for a single
217
+ request; this effectively ignores the headers
218
+ in the spec for a single request.
219
+ :type _headers: dict, optional
220
+ :param _host_index: set to override the host_index for a single
221
+ request; this effectively ignores the host_index
222
+ in the spec for a single request.
223
+ :type _host_index: int, optional
224
+ :return: Returns the result object.
225
+ """ # noqa: E501
226
+
227
+ _param = self._create_webhook_serialize(
228
+ designer_webhook_webhook_request_dto=designer_webhook_webhook_request_dto,
229
+ _request_auth=_request_auth,
230
+ _content_type=_content_type,
231
+ _headers=_headers,
232
+ _host_index=_host_index
233
+ )
234
+
235
+ _response_types_map: Dict[str, Optional[str]] = {
236
+ '200': "DesignerWebhookWebhookDTO",
237
+ }
238
+ response_data = self.api_client.call_api(
239
+ *_param,
240
+ _request_timeout=_request_timeout
241
+ )
242
+ return response_data.response
243
+
244
+
245
+ def _create_webhook_serialize(
246
+ self,
247
+ designer_webhook_webhook_request_dto,
248
+ _request_auth,
249
+ _content_type,
250
+ _headers,
251
+ _host_index,
252
+ ) -> RequestSerialized:
253
+
254
+ _host = None
255
+
256
+ _collection_formats: Dict[str, str] = {
257
+ }
258
+
259
+ _path_params: Dict[str, str] = {}
260
+ _query_params: List[Tuple[str, str]] = []
261
+ _header_params: Dict[str, Optional[str]] = _headers or {}
262
+ _form_params: List[Tuple[str, str]] = []
263
+ _files: Dict[
264
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
265
+ ] = {}
266
+ _body_params: Optional[bytes] = None
267
+
268
+ # process the path parameters
269
+ # process the query parameters
270
+ # process the header parameters
271
+ # process the form parameters
272
+ # process the body parameter
273
+ if designer_webhook_webhook_request_dto is not None:
274
+ _body_params = designer_webhook_webhook_request_dto
275
+
276
+
277
+ # set the HTTP header `Accept`
278
+ if 'Accept' not in _header_params:
279
+ _header_params['Accept'] = self.api_client.select_header_accept(
280
+ [
281
+ 'application/json'
282
+ ]
283
+ )
284
+
285
+ # set the HTTP header `Content-Type`
286
+ if _content_type:
287
+ _header_params['Content-Type'] = _content_type
288
+ else:
289
+ _default_content_type = (
290
+ self.api_client.select_header_content_type(
291
+ [
292
+ 'application/json'
293
+ ]
294
+ )
295
+ )
296
+ if _default_content_type is not None:
297
+ _header_params['Content-Type'] = _default_content_type
298
+
299
+ # authentication setting
300
+ _auth_settings: List[str] = [
301
+ 'CookieAuth',
302
+ 'ApiKeyAuth',
303
+ 'OAuth2Auth',
304
+ 'OAuth2Auth',
305
+ 'BearerAuth'
306
+ ]
307
+
308
+ return self.api_client.param_serialize(
309
+ method='POST',
310
+ resource_path='/v1beta/op/webhooks',
311
+ path_params=_path_params,
312
+ query_params=_query_params,
313
+ header_params=_header_params,
314
+ body=_body_params,
315
+ post_params=_form_params,
316
+ files=_files,
317
+ auth_settings=_auth_settings,
318
+ collection_formats=_collection_formats,
319
+ _host=_host,
320
+ _request_auth=_request_auth
321
+ )
322
+
323
+
324
+
325
+
326
+ @validate_call
327
+ def delete_webhook(
328
+ self,
329
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
330
+ _request_timeout: Union[
331
+ None,
332
+ Annotated[StrictFloat, Field(gt=0)],
333
+ Tuple[
334
+ Annotated[StrictFloat, Field(gt=0)],
335
+ Annotated[StrictFloat, Field(gt=0)]
336
+ ]
337
+ ] = None,
338
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
339
+ _content_type: Optional[StrictStr] = None,
340
+ _headers: Optional[Dict[StrictStr, Any]] = None,
341
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
342
+ ) -> DesignerWebhookWebhookDTO:
343
+ """Delete a webhook
344
+
345
+ Delete a specific webhook. You must know the ID of the webhook to delete it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
346
+
347
+ :param webhook_id: The unique identifier of the webhook. (required)
348
+ :type webhook_id: str
349
+ :param _request_timeout: timeout setting for this request. If one
350
+ number provided, it will be total request
351
+ timeout. It can also be a pair (tuple) of
352
+ (connection, read) timeouts.
353
+ :type _request_timeout: int, tuple(int, int), optional
354
+ :param _request_auth: set to override the auth_settings for an a single
355
+ request; this effectively ignores the
356
+ authentication in the spec for a single request.
357
+ :type _request_auth: dict, optional
358
+ :param _content_type: force content-type for the request.
359
+ :type _content_type: str, Optional
360
+ :param _headers: set to override the headers for a single
361
+ request; this effectively ignores the headers
362
+ in the spec for a single request.
363
+ :type _headers: dict, optional
364
+ :param _host_index: set to override the host_index for a single
365
+ request; this effectively ignores the host_index
366
+ in the spec for a single request.
367
+ :type _host_index: int, optional
368
+ :return: Returns the result object.
369
+ """ # noqa: E501
370
+
371
+ _param = self._delete_webhook_serialize(
372
+ webhook_id=webhook_id,
373
+ _request_auth=_request_auth,
374
+ _content_type=_content_type,
375
+ _headers=_headers,
376
+ _host_index=_host_index
377
+ )
378
+
379
+ _response_types_map: Dict[str, Optional[str]] = {
380
+ '200': "DesignerWebhookWebhookDTO",
381
+ }
382
+ response_data = self.api_client.call_api(
383
+ *_param,
384
+ _request_timeout=_request_timeout
385
+ )
386
+ response_data.read()
387
+ return self.api_client.response_deserialize(
388
+ response_data=response_data,
389
+ response_types_map=_response_types_map,
390
+ ).data
391
+
392
+
393
+ @validate_call
394
+ def delete_webhook_with_http_info(
395
+ self,
396
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
397
+ _request_timeout: Union[
398
+ None,
399
+ Annotated[StrictFloat, Field(gt=0)],
400
+ Tuple[
401
+ Annotated[StrictFloat, Field(gt=0)],
402
+ Annotated[StrictFloat, Field(gt=0)]
403
+ ]
404
+ ] = None,
405
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
406
+ _content_type: Optional[StrictStr] = None,
407
+ _headers: Optional[Dict[StrictStr, Any]] = None,
408
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
409
+ ) -> ApiResponse[DesignerWebhookWebhookDTO]:
410
+ """Delete a webhook
411
+
412
+ Delete a specific webhook. You must know the ID of the webhook to delete it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
413
+
414
+ :param webhook_id: The unique identifier of the webhook. (required)
415
+ :type webhook_id: str
416
+ :param _request_timeout: timeout setting for this request. If one
417
+ number provided, it will be total request
418
+ timeout. It can also be a pair (tuple) of
419
+ (connection, read) timeouts.
420
+ :type _request_timeout: int, tuple(int, int), optional
421
+ :param _request_auth: set to override the auth_settings for an a single
422
+ request; this effectively ignores the
423
+ authentication in the spec for a single request.
424
+ :type _request_auth: dict, optional
425
+ :param _content_type: force content-type for the request.
426
+ :type _content_type: str, Optional
427
+ :param _headers: set to override the headers for a single
428
+ request; this effectively ignores the headers
429
+ in the spec for a single request.
430
+ :type _headers: dict, optional
431
+ :param _host_index: set to override the host_index for a single
432
+ request; this effectively ignores the host_index
433
+ in the spec for a single request.
434
+ :type _host_index: int, optional
435
+ :return: Returns the result object.
436
+ """ # noqa: E501
437
+
438
+ _param = self._delete_webhook_serialize(
439
+ webhook_id=webhook_id,
440
+ _request_auth=_request_auth,
441
+ _content_type=_content_type,
442
+ _headers=_headers,
443
+ _host_index=_host_index
444
+ )
445
+
446
+ _response_types_map: Dict[str, Optional[str]] = {
447
+ '200': "DesignerWebhookWebhookDTO",
448
+ }
449
+ response_data = self.api_client.call_api(
450
+ *_param,
451
+ _request_timeout=_request_timeout
452
+ )
453
+ response_data.read()
454
+ return self.api_client.response_deserialize(
455
+ response_data=response_data,
456
+ response_types_map=_response_types_map,
457
+ )
458
+
459
+
460
+ @validate_call
461
+ def delete_webhook_without_preload_content(
462
+ self,
463
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
464
+ _request_timeout: Union[
465
+ None,
466
+ Annotated[StrictFloat, Field(gt=0)],
467
+ Tuple[
468
+ Annotated[StrictFloat, Field(gt=0)],
469
+ Annotated[StrictFloat, Field(gt=0)]
470
+ ]
471
+ ] = None,
472
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
473
+ _content_type: Optional[StrictStr] = None,
474
+ _headers: Optional[Dict[StrictStr, Any]] = None,
475
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
476
+ ) -> RESTResponseType:
477
+ """Delete a webhook
478
+
479
+ Delete a specific webhook. You must know the ID of the webhook to delete it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
480
+
481
+ :param webhook_id: The unique identifier of the webhook. (required)
482
+ :type webhook_id: str
483
+ :param _request_timeout: timeout setting for this request. If one
484
+ number provided, it will be total request
485
+ timeout. It can also be a pair (tuple) of
486
+ (connection, read) timeouts.
487
+ :type _request_timeout: int, tuple(int, int), optional
488
+ :param _request_auth: set to override the auth_settings for an a single
489
+ request; this effectively ignores the
490
+ authentication in the spec for a single request.
491
+ :type _request_auth: dict, optional
492
+ :param _content_type: force content-type for the request.
493
+ :type _content_type: str, Optional
494
+ :param _headers: set to override the headers for a single
495
+ request; this effectively ignores the headers
496
+ in the spec for a single request.
497
+ :type _headers: dict, optional
498
+ :param _host_index: set to override the host_index for a single
499
+ request; this effectively ignores the host_index
500
+ in the spec for a single request.
501
+ :type _host_index: int, optional
502
+ :return: Returns the result object.
503
+ """ # noqa: E501
504
+
505
+ _param = self._delete_webhook_serialize(
506
+ webhook_id=webhook_id,
507
+ _request_auth=_request_auth,
508
+ _content_type=_content_type,
509
+ _headers=_headers,
510
+ _host_index=_host_index
511
+ )
512
+
513
+ _response_types_map: Dict[str, Optional[str]] = {
514
+ '200': "DesignerWebhookWebhookDTO",
515
+ }
516
+ response_data = self.api_client.call_api(
517
+ *_param,
518
+ _request_timeout=_request_timeout
519
+ )
520
+ return response_data.response
521
+
522
+
523
+ def _delete_webhook_serialize(
524
+ self,
525
+ webhook_id,
526
+ _request_auth,
527
+ _content_type,
528
+ _headers,
529
+ _host_index,
530
+ ) -> RequestSerialized:
531
+
532
+ _host = None
533
+
534
+ _collection_formats: Dict[str, str] = {
535
+ }
536
+
537
+ _path_params: Dict[str, str] = {}
538
+ _query_params: List[Tuple[str, str]] = []
539
+ _header_params: Dict[str, Optional[str]] = _headers or {}
540
+ _form_params: List[Tuple[str, str]] = []
541
+ _files: Dict[
542
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
543
+ ] = {}
544
+ _body_params: Optional[bytes] = None
545
+
546
+ # process the path parameters
547
+ if webhook_id is not None:
548
+ _path_params['webhookId'] = webhook_id
549
+ # process the query parameters
550
+ # process the header parameters
551
+ # process the form parameters
552
+ # process the body parameter
553
+
554
+
555
+ # set the HTTP header `Accept`
556
+ if 'Accept' not in _header_params:
557
+ _header_params['Accept'] = self.api_client.select_header_accept(
558
+ [
559
+ 'application/json'
560
+ ]
561
+ )
562
+
563
+
564
+ # authentication setting
565
+ _auth_settings: List[str] = [
566
+ 'CookieAuth',
567
+ 'ApiKeyAuth',
568
+ 'OAuth2Auth',
569
+ 'OAuth2Auth',
570
+ 'BearerAuth'
571
+ ]
572
+
573
+ return self.api_client.param_serialize(
574
+ method='DELETE',
575
+ resource_path='/v1beta/op/webhooks/{webhookId}',
576
+ path_params=_path_params,
577
+ query_params=_query_params,
578
+ header_params=_header_params,
579
+ body=_body_params,
580
+ post_params=_form_params,
581
+ files=_files,
582
+ auth_settings=_auth_settings,
583
+ collection_formats=_collection_formats,
584
+ _host=_host,
585
+ _request_auth=_request_auth
586
+ )
587
+
588
+
589
+
590
+
591
+ @validate_call
592
+ def delete_webhook_credentials(
593
+ self,
594
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
595
+ _request_timeout: Union[
596
+ None,
597
+ Annotated[StrictFloat, Field(gt=0)],
598
+ Tuple[
599
+ Annotated[StrictFloat, Field(gt=0)],
600
+ Annotated[StrictFloat, Field(gt=0)]
601
+ ]
602
+ ] = None,
603
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
604
+ _content_type: Optional[StrictStr] = None,
605
+ _headers: Optional[Dict[StrictStr, Any]] = None,
606
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
607
+ ) -> DesignerWebhookWebhookDTO:
608
+ """Delete a webhook's credentials
609
+
610
+ Delete the credentials for a webhook. You must know the ID of the webhook to delete its credentials. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
611
+
612
+ :param webhook_id: The unique identifier of the webhook. (required)
613
+ :type webhook_id: str
614
+ :param _request_timeout: timeout setting for this request. If one
615
+ number provided, it will be total request
616
+ timeout. It can also be a pair (tuple) of
617
+ (connection, read) timeouts.
618
+ :type _request_timeout: int, tuple(int, int), optional
619
+ :param _request_auth: set to override the auth_settings for an a single
620
+ request; this effectively ignores the
621
+ authentication in the spec for a single request.
622
+ :type _request_auth: dict, optional
623
+ :param _content_type: force content-type for the request.
624
+ :type _content_type: str, Optional
625
+ :param _headers: set to override the headers for a single
626
+ request; this effectively ignores the headers
627
+ in the spec for a single request.
628
+ :type _headers: dict, optional
629
+ :param _host_index: set to override the host_index for a single
630
+ request; this effectively ignores the host_index
631
+ in the spec for a single request.
632
+ :type _host_index: int, optional
633
+ :return: Returns the result object.
634
+ """ # noqa: E501
635
+
636
+ _param = self._delete_webhook_credentials_serialize(
637
+ webhook_id=webhook_id,
638
+ _request_auth=_request_auth,
639
+ _content_type=_content_type,
640
+ _headers=_headers,
641
+ _host_index=_host_index
642
+ )
643
+
644
+ _response_types_map: Dict[str, Optional[str]] = {
645
+ '200': "DesignerWebhookWebhookDTO",
646
+ }
647
+ response_data = self.api_client.call_api(
648
+ *_param,
649
+ _request_timeout=_request_timeout
650
+ )
651
+ response_data.read()
652
+ return self.api_client.response_deserialize(
653
+ response_data=response_data,
654
+ response_types_map=_response_types_map,
655
+ ).data
656
+
657
+
658
+ @validate_call
659
+ def delete_webhook_credentials_with_http_info(
660
+ self,
661
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
662
+ _request_timeout: Union[
663
+ None,
664
+ Annotated[StrictFloat, Field(gt=0)],
665
+ Tuple[
666
+ Annotated[StrictFloat, Field(gt=0)],
667
+ Annotated[StrictFloat, Field(gt=0)]
668
+ ]
669
+ ] = None,
670
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
671
+ _content_type: Optional[StrictStr] = None,
672
+ _headers: Optional[Dict[StrictStr, Any]] = None,
673
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
674
+ ) -> ApiResponse[DesignerWebhookWebhookDTO]:
675
+ """Delete a webhook's credentials
676
+
677
+ Delete the credentials for a webhook. You must know the ID of the webhook to delete its credentials. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
678
+
679
+ :param webhook_id: The unique identifier of the webhook. (required)
680
+ :type webhook_id: str
681
+ :param _request_timeout: timeout setting for this request. If one
682
+ number provided, it will be total request
683
+ timeout. It can also be a pair (tuple) of
684
+ (connection, read) timeouts.
685
+ :type _request_timeout: int, tuple(int, int), optional
686
+ :param _request_auth: set to override the auth_settings for an a single
687
+ request; this effectively ignores the
688
+ authentication in the spec for a single request.
689
+ :type _request_auth: dict, optional
690
+ :param _content_type: force content-type for the request.
691
+ :type _content_type: str, Optional
692
+ :param _headers: set to override the headers for a single
693
+ request; this effectively ignores the headers
694
+ in the spec for a single request.
695
+ :type _headers: dict, optional
696
+ :param _host_index: set to override the host_index for a single
697
+ request; this effectively ignores the host_index
698
+ in the spec for a single request.
699
+ :type _host_index: int, optional
700
+ :return: Returns the result object.
701
+ """ # noqa: E501
702
+
703
+ _param = self._delete_webhook_credentials_serialize(
704
+ webhook_id=webhook_id,
705
+ _request_auth=_request_auth,
706
+ _content_type=_content_type,
707
+ _headers=_headers,
708
+ _host_index=_host_index
709
+ )
710
+
711
+ _response_types_map: Dict[str, Optional[str]] = {
712
+ '200': "DesignerWebhookWebhookDTO",
713
+ }
714
+ response_data = self.api_client.call_api(
715
+ *_param,
716
+ _request_timeout=_request_timeout
717
+ )
718
+ response_data.read()
719
+ return self.api_client.response_deserialize(
720
+ response_data=response_data,
721
+ response_types_map=_response_types_map,
722
+ )
723
+
724
+
725
+ @validate_call
726
+ def delete_webhook_credentials_without_preload_content(
727
+ self,
728
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
729
+ _request_timeout: Union[
730
+ None,
731
+ Annotated[StrictFloat, Field(gt=0)],
732
+ Tuple[
733
+ Annotated[StrictFloat, Field(gt=0)],
734
+ Annotated[StrictFloat, Field(gt=0)]
735
+ ]
736
+ ] = None,
737
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
738
+ _content_type: Optional[StrictStr] = None,
739
+ _headers: Optional[Dict[StrictStr, Any]] = None,
740
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
741
+ ) -> RESTResponseType:
742
+ """Delete a webhook's credentials
743
+
744
+ Delete the credentials for a webhook. You must know the ID of the webhook to delete its credentials. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
745
+
746
+ :param webhook_id: The unique identifier of the webhook. (required)
747
+ :type webhook_id: str
748
+ :param _request_timeout: timeout setting for this request. If one
749
+ number provided, it will be total request
750
+ timeout. It can also be a pair (tuple) of
751
+ (connection, read) timeouts.
752
+ :type _request_timeout: int, tuple(int, int), optional
753
+ :param _request_auth: set to override the auth_settings for an a single
754
+ request; this effectively ignores the
755
+ authentication in the spec for a single request.
756
+ :type _request_auth: dict, optional
757
+ :param _content_type: force content-type for the request.
758
+ :type _content_type: str, Optional
759
+ :param _headers: set to override the headers for a single
760
+ request; this effectively ignores the headers
761
+ in the spec for a single request.
762
+ :type _headers: dict, optional
763
+ :param _host_index: set to override the host_index for a single
764
+ request; this effectively ignores the host_index
765
+ in the spec for a single request.
766
+ :type _host_index: int, optional
767
+ :return: Returns the result object.
768
+ """ # noqa: E501
769
+
770
+ _param = self._delete_webhook_credentials_serialize(
771
+ webhook_id=webhook_id,
772
+ _request_auth=_request_auth,
773
+ _content_type=_content_type,
774
+ _headers=_headers,
775
+ _host_index=_host_index
776
+ )
777
+
778
+ _response_types_map: Dict[str, Optional[str]] = {
779
+ '200': "DesignerWebhookWebhookDTO",
780
+ }
781
+ response_data = self.api_client.call_api(
782
+ *_param,
783
+ _request_timeout=_request_timeout
784
+ )
785
+ return response_data.response
786
+
787
+
788
+ def _delete_webhook_credentials_serialize(
789
+ self,
790
+ webhook_id,
791
+ _request_auth,
792
+ _content_type,
793
+ _headers,
794
+ _host_index,
795
+ ) -> RequestSerialized:
796
+
797
+ _host = None
798
+
799
+ _collection_formats: Dict[str, str] = {
800
+ }
801
+
802
+ _path_params: Dict[str, str] = {}
803
+ _query_params: List[Tuple[str, str]] = []
804
+ _header_params: Dict[str, Optional[str]] = _headers or {}
805
+ _form_params: List[Tuple[str, str]] = []
806
+ _files: Dict[
807
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
808
+ ] = {}
809
+ _body_params: Optional[bytes] = None
810
+
811
+ # process the path parameters
812
+ if webhook_id is not None:
813
+ _path_params['webhookId'] = webhook_id
814
+ # process the query parameters
815
+ # process the header parameters
816
+ # process the form parameters
817
+ # process the body parameter
818
+
819
+
820
+ # set the HTTP header `Accept`
821
+ if 'Accept' not in _header_params:
822
+ _header_params['Accept'] = self.api_client.select_header_accept(
823
+ [
824
+ 'application/json'
825
+ ]
826
+ )
827
+
828
+
829
+ # authentication setting
830
+ _auth_settings: List[str] = [
831
+ 'CookieAuth',
832
+ 'ApiKeyAuth',
833
+ 'OAuth2Auth',
834
+ 'OAuth2Auth',
835
+ 'BearerAuth'
836
+ ]
837
+
838
+ return self.api_client.param_serialize(
839
+ method='DELETE',
840
+ resource_path='/v1beta/op/webhooks/{webhookId}/credentials',
841
+ path_params=_path_params,
842
+ query_params=_query_params,
843
+ header_params=_header_params,
844
+ body=_body_params,
845
+ post_params=_form_params,
846
+ files=_files,
847
+ auth_settings=_auth_settings,
848
+ collection_formats=_collection_formats,
849
+ _host=_host,
850
+ _request_auth=_request_auth
851
+ )
852
+
853
+
854
+
855
+
856
+ @validate_call
857
+ def get_all_webhooks(
858
+ self,
859
+ event: Annotated[Optional[StrictStr], Field(description="Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.")] = None,
860
+ is_active: Annotated[Optional[StrictBool], Field(description="If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`.")] = None,
861
+ _request_timeout: Union[
862
+ None,
863
+ Annotated[StrictFloat, Field(gt=0)],
864
+ Tuple[
865
+ Annotated[StrictFloat, Field(gt=0)],
866
+ Annotated[StrictFloat, Field(gt=0)]
867
+ ]
868
+ ] = None,
869
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
870
+ _content_type: Optional[StrictStr] = None,
871
+ _headers: Optional[Dict[StrictStr, Any]] = None,
872
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
873
+ ) -> DesignerWebhookWebhooksDTO:
874
+ """Retrieve a list of webhooks
875
+
876
+ Retrieve a list of all webhooks. The response returns each webhook's definition, such as its endpoint URL, active status, and event types. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
877
+
878
+ :param event: Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.
879
+ :type event: str
880
+ :param is_active: If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`.
881
+ :type is_active: bool
882
+ :param _request_timeout: timeout setting for this request. If one
883
+ number provided, it will be total request
884
+ timeout. It can also be a pair (tuple) of
885
+ (connection, read) timeouts.
886
+ :type _request_timeout: int, tuple(int, int), optional
887
+ :param _request_auth: set to override the auth_settings for an a single
888
+ request; this effectively ignores the
889
+ authentication in the spec for a single request.
890
+ :type _request_auth: dict, optional
891
+ :param _content_type: force content-type for the request.
892
+ :type _content_type: str, Optional
893
+ :param _headers: set to override the headers for a single
894
+ request; this effectively ignores the headers
895
+ in the spec for a single request.
896
+ :type _headers: dict, optional
897
+ :param _host_index: set to override the host_index for a single
898
+ request; this effectively ignores the host_index
899
+ in the spec for a single request.
900
+ :type _host_index: int, optional
901
+ :return: Returns the result object.
902
+ """ # noqa: E501
903
+
904
+ _param = self._get_all_webhooks_serialize(
905
+ event=event,
906
+ is_active=is_active,
907
+ _request_auth=_request_auth,
908
+ _content_type=_content_type,
909
+ _headers=_headers,
910
+ _host_index=_host_index
911
+ )
912
+
913
+ _response_types_map: Dict[str, Optional[str]] = {
914
+ '200': "DesignerWebhookWebhooksDTO",
915
+ }
916
+ response_data = self.api_client.call_api(
917
+ *_param,
918
+ _request_timeout=_request_timeout
919
+ )
920
+ response_data.read()
921
+ return self.api_client.response_deserialize(
922
+ response_data=response_data,
923
+ response_types_map=_response_types_map,
924
+ ).data
925
+
926
+
927
+ @validate_call
928
+ def get_all_webhooks_with_http_info(
929
+ self,
930
+ event: Annotated[Optional[StrictStr], Field(description="Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.")] = None,
931
+ is_active: Annotated[Optional[StrictBool], Field(description="If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`.")] = None,
932
+ _request_timeout: Union[
933
+ None,
934
+ Annotated[StrictFloat, Field(gt=0)],
935
+ Tuple[
936
+ Annotated[StrictFloat, Field(gt=0)],
937
+ Annotated[StrictFloat, Field(gt=0)]
938
+ ]
939
+ ] = None,
940
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
941
+ _content_type: Optional[StrictStr] = None,
942
+ _headers: Optional[Dict[StrictStr, Any]] = None,
943
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
944
+ ) -> ApiResponse[DesignerWebhookWebhooksDTO]:
945
+ """Retrieve a list of webhooks
946
+
947
+ Retrieve a list of all webhooks. The response returns each webhook's definition, such as its endpoint URL, active status, and event types. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
948
+
949
+ :param event: Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.
950
+ :type event: str
951
+ :param is_active: If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`.
952
+ :type is_active: bool
953
+ :param _request_timeout: timeout setting for this request. If one
954
+ number provided, it will be total request
955
+ timeout. It can also be a pair (tuple) of
956
+ (connection, read) timeouts.
957
+ :type _request_timeout: int, tuple(int, int), optional
958
+ :param _request_auth: set to override the auth_settings for an a single
959
+ request; this effectively ignores the
960
+ authentication in the spec for a single request.
961
+ :type _request_auth: dict, optional
962
+ :param _content_type: force content-type for the request.
963
+ :type _content_type: str, Optional
964
+ :param _headers: set to override the headers for a single
965
+ request; this effectively ignores the headers
966
+ in the spec for a single request.
967
+ :type _headers: dict, optional
968
+ :param _host_index: set to override the host_index for a single
969
+ request; this effectively ignores the host_index
970
+ in the spec for a single request.
971
+ :type _host_index: int, optional
972
+ :return: Returns the result object.
973
+ """ # noqa: E501
974
+
975
+ _param = self._get_all_webhooks_serialize(
976
+ event=event,
977
+ is_active=is_active,
978
+ _request_auth=_request_auth,
979
+ _content_type=_content_type,
980
+ _headers=_headers,
981
+ _host_index=_host_index
982
+ )
983
+
984
+ _response_types_map: Dict[str, Optional[str]] = {
985
+ '200': "DesignerWebhookWebhooksDTO",
986
+ }
987
+ response_data = self.api_client.call_api(
988
+ *_param,
989
+ _request_timeout=_request_timeout
990
+ )
991
+ response_data.read()
992
+ return self.api_client.response_deserialize(
993
+ response_data=response_data,
994
+ response_types_map=_response_types_map,
995
+ )
996
+
997
+
998
+ @validate_call
999
+ def get_all_webhooks_without_preload_content(
1000
+ self,
1001
+ event: Annotated[Optional[StrictStr], Field(description="Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.")] = None,
1002
+ is_active: Annotated[Optional[StrictBool], Field(description="If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`.")] = None,
1003
+ _request_timeout: Union[
1004
+ None,
1005
+ Annotated[StrictFloat, Field(gt=0)],
1006
+ Tuple[
1007
+ Annotated[StrictFloat, Field(gt=0)],
1008
+ Annotated[StrictFloat, Field(gt=0)]
1009
+ ]
1010
+ ] = None,
1011
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1012
+ _content_type: Optional[StrictStr] = None,
1013
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1014
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1015
+ ) -> RESTResponseType:
1016
+ """Retrieve a list of webhooks
1017
+
1018
+ Retrieve a list of all webhooks. The response returns each webhook's definition, such as its endpoint URL, active status, and event types. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1019
+
1020
+ :param event: Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.
1021
+ :type event: str
1022
+ :param is_active: If `true`, retrieve active webhooks only. If `false`, retrieve active and inactive webhooks. Default is `false`.
1023
+ :type is_active: bool
1024
+ :param _request_timeout: timeout setting for this request. If one
1025
+ number provided, it will be total request
1026
+ timeout. It can also be a pair (tuple) of
1027
+ (connection, read) timeouts.
1028
+ :type _request_timeout: int, tuple(int, int), optional
1029
+ :param _request_auth: set to override the auth_settings for an a single
1030
+ request; this effectively ignores the
1031
+ authentication in the spec for a single request.
1032
+ :type _request_auth: dict, optional
1033
+ :param _content_type: force content-type for the request.
1034
+ :type _content_type: str, Optional
1035
+ :param _headers: set to override the headers for a single
1036
+ request; this effectively ignores the headers
1037
+ in the spec for a single request.
1038
+ :type _headers: dict, optional
1039
+ :param _host_index: set to override the host_index for a single
1040
+ request; this effectively ignores the host_index
1041
+ in the spec for a single request.
1042
+ :type _host_index: int, optional
1043
+ :return: Returns the result object.
1044
+ """ # noqa: E501
1045
+
1046
+ _param = self._get_all_webhooks_serialize(
1047
+ event=event,
1048
+ is_active=is_active,
1049
+ _request_auth=_request_auth,
1050
+ _content_type=_content_type,
1051
+ _headers=_headers,
1052
+ _host_index=_host_index
1053
+ )
1054
+
1055
+ _response_types_map: Dict[str, Optional[str]] = {
1056
+ '200': "DesignerWebhookWebhooksDTO",
1057
+ }
1058
+ response_data = self.api_client.call_api(
1059
+ *_param,
1060
+ _request_timeout=_request_timeout
1061
+ )
1062
+ return response_data.response
1063
+
1064
+
1065
+ def _get_all_webhooks_serialize(
1066
+ self,
1067
+ event,
1068
+ is_active,
1069
+ _request_auth,
1070
+ _content_type,
1071
+ _headers,
1072
+ _host_index,
1073
+ ) -> RequestSerialized:
1074
+
1075
+ _host = None
1076
+
1077
+ _collection_formats: Dict[str, str] = {
1078
+ }
1079
+
1080
+ _path_params: Dict[str, str] = {}
1081
+ _query_params: List[Tuple[str, str]] = []
1082
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1083
+ _form_params: List[Tuple[str, str]] = []
1084
+ _files: Dict[
1085
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1086
+ ] = {}
1087
+ _body_params: Optional[bytes] = None
1088
+
1089
+ # process the path parameters
1090
+ # process the query parameters
1091
+ if event is not None:
1092
+
1093
+ _query_params.append(('event', event))
1094
+
1095
+ if is_active is not None:
1096
+
1097
+ _query_params.append(('isActive', is_active))
1098
+
1099
+ # process the header parameters
1100
+ # process the form parameters
1101
+ # process the body parameter
1102
+
1103
+
1104
+ # set the HTTP header `Accept`
1105
+ if 'Accept' not in _header_params:
1106
+ _header_params['Accept'] = self.api_client.select_header_accept(
1107
+ [
1108
+ 'application/json'
1109
+ ]
1110
+ )
1111
+
1112
+
1113
+ # authentication setting
1114
+ _auth_settings: List[str] = [
1115
+ 'CookieAuth',
1116
+ 'ApiKeyAuth',
1117
+ 'OAuth2Auth',
1118
+ 'OAuth2Auth',
1119
+ 'BearerAuth'
1120
+ ]
1121
+
1122
+ return self.api_client.param_serialize(
1123
+ method='GET',
1124
+ resource_path='/v1beta/op/webhooks',
1125
+ path_params=_path_params,
1126
+ query_params=_query_params,
1127
+ header_params=_header_params,
1128
+ body=_body_params,
1129
+ post_params=_form_params,
1130
+ files=_files,
1131
+ auth_settings=_auth_settings,
1132
+ collection_formats=_collection_formats,
1133
+ _host=_host,
1134
+ _request_auth=_request_auth
1135
+ )
1136
+
1137
+
1138
+
1139
+
1140
+ @validate_call
1141
+ def get_webhook(
1142
+ self,
1143
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
1144
+ _request_timeout: Union[
1145
+ None,
1146
+ Annotated[StrictFloat, Field(gt=0)],
1147
+ Tuple[
1148
+ Annotated[StrictFloat, Field(gt=0)],
1149
+ Annotated[StrictFloat, Field(gt=0)]
1150
+ ]
1151
+ ] = None,
1152
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1153
+ _content_type: Optional[StrictStr] = None,
1154
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1155
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1156
+ ) -> DesignerWebhookWebhookDTO:
1157
+ """Retrieve a webhook's details
1158
+
1159
+ Retrieve the details of a specific webhook. You must know the ID of the webhook to retrieve its details. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1160
+
1161
+ :param webhook_id: The unique identifier of the webhook. (required)
1162
+ :type webhook_id: str
1163
+ :param _request_timeout: timeout setting for this request. If one
1164
+ number provided, it will be total request
1165
+ timeout. It can also be a pair (tuple) of
1166
+ (connection, read) timeouts.
1167
+ :type _request_timeout: int, tuple(int, int), optional
1168
+ :param _request_auth: set to override the auth_settings for an a single
1169
+ request; this effectively ignores the
1170
+ authentication in the spec for a single request.
1171
+ :type _request_auth: dict, optional
1172
+ :param _content_type: force content-type for the request.
1173
+ :type _content_type: str, Optional
1174
+ :param _headers: set to override the headers for a single
1175
+ request; this effectively ignores the headers
1176
+ in the spec for a single request.
1177
+ :type _headers: dict, optional
1178
+ :param _host_index: set to override the host_index for a single
1179
+ request; this effectively ignores the host_index
1180
+ in the spec for a single request.
1181
+ :type _host_index: int, optional
1182
+ :return: Returns the result object.
1183
+ """ # noqa: E501
1184
+
1185
+ _param = self._get_webhook_serialize(
1186
+ webhook_id=webhook_id,
1187
+ _request_auth=_request_auth,
1188
+ _content_type=_content_type,
1189
+ _headers=_headers,
1190
+ _host_index=_host_index
1191
+ )
1192
+
1193
+ _response_types_map: Dict[str, Optional[str]] = {
1194
+ '200': "DesignerWebhookWebhookDTO",
1195
+ }
1196
+ response_data = self.api_client.call_api(
1197
+ *_param,
1198
+ _request_timeout=_request_timeout
1199
+ )
1200
+ response_data.read()
1201
+ return self.api_client.response_deserialize(
1202
+ response_data=response_data,
1203
+ response_types_map=_response_types_map,
1204
+ ).data
1205
+
1206
+
1207
+ @validate_call
1208
+ def get_webhook_with_http_info(
1209
+ self,
1210
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
1211
+ _request_timeout: Union[
1212
+ None,
1213
+ Annotated[StrictFloat, Field(gt=0)],
1214
+ Tuple[
1215
+ Annotated[StrictFloat, Field(gt=0)],
1216
+ Annotated[StrictFloat, Field(gt=0)]
1217
+ ]
1218
+ ] = None,
1219
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1220
+ _content_type: Optional[StrictStr] = None,
1221
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1222
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1223
+ ) -> ApiResponse[DesignerWebhookWebhookDTO]:
1224
+ """Retrieve a webhook's details
1225
+
1226
+ Retrieve the details of a specific webhook. You must know the ID of the webhook to retrieve its details. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1227
+
1228
+ :param webhook_id: The unique identifier of the webhook. (required)
1229
+ :type webhook_id: str
1230
+ :param _request_timeout: timeout setting for this request. If one
1231
+ number provided, it will be total request
1232
+ timeout. It can also be a pair (tuple) of
1233
+ (connection, read) timeouts.
1234
+ :type _request_timeout: int, tuple(int, int), optional
1235
+ :param _request_auth: set to override the auth_settings for an a single
1236
+ request; this effectively ignores the
1237
+ authentication in the spec for a single request.
1238
+ :type _request_auth: dict, optional
1239
+ :param _content_type: force content-type for the request.
1240
+ :type _content_type: str, Optional
1241
+ :param _headers: set to override the headers for a single
1242
+ request; this effectively ignores the headers
1243
+ in the spec for a single request.
1244
+ :type _headers: dict, optional
1245
+ :param _host_index: set to override the host_index for a single
1246
+ request; this effectively ignores the host_index
1247
+ in the spec for a single request.
1248
+ :type _host_index: int, optional
1249
+ :return: Returns the result object.
1250
+ """ # noqa: E501
1251
+
1252
+ _param = self._get_webhook_serialize(
1253
+ webhook_id=webhook_id,
1254
+ _request_auth=_request_auth,
1255
+ _content_type=_content_type,
1256
+ _headers=_headers,
1257
+ _host_index=_host_index
1258
+ )
1259
+
1260
+ _response_types_map: Dict[str, Optional[str]] = {
1261
+ '200': "DesignerWebhookWebhookDTO",
1262
+ }
1263
+ response_data = self.api_client.call_api(
1264
+ *_param,
1265
+ _request_timeout=_request_timeout
1266
+ )
1267
+ response_data.read()
1268
+ return self.api_client.response_deserialize(
1269
+ response_data=response_data,
1270
+ response_types_map=_response_types_map,
1271
+ )
1272
+
1273
+
1274
+ @validate_call
1275
+ def get_webhook_without_preload_content(
1276
+ self,
1277
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
1278
+ _request_timeout: Union[
1279
+ None,
1280
+ Annotated[StrictFloat, Field(gt=0)],
1281
+ Tuple[
1282
+ Annotated[StrictFloat, Field(gt=0)],
1283
+ Annotated[StrictFloat, Field(gt=0)]
1284
+ ]
1285
+ ] = None,
1286
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1287
+ _content_type: Optional[StrictStr] = None,
1288
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1289
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1290
+ ) -> RESTResponseType:
1291
+ """Retrieve a webhook's details
1292
+
1293
+ Retrieve the details of a specific webhook. You must know the ID of the webhook to retrieve its details. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1294
+
1295
+ :param webhook_id: The unique identifier of the webhook. (required)
1296
+ :type webhook_id: str
1297
+ :param _request_timeout: timeout setting for this request. If one
1298
+ number provided, it will be total request
1299
+ timeout. It can also be a pair (tuple) of
1300
+ (connection, read) timeouts.
1301
+ :type _request_timeout: int, tuple(int, int), optional
1302
+ :param _request_auth: set to override the auth_settings for an a single
1303
+ request; this effectively ignores the
1304
+ authentication in the spec for a single request.
1305
+ :type _request_auth: dict, optional
1306
+ :param _content_type: force content-type for the request.
1307
+ :type _content_type: str, Optional
1308
+ :param _headers: set to override the headers for a single
1309
+ request; this effectively ignores the headers
1310
+ in the spec for a single request.
1311
+ :type _headers: dict, optional
1312
+ :param _host_index: set to override the host_index for a single
1313
+ request; this effectively ignores the host_index
1314
+ in the spec for a single request.
1315
+ :type _host_index: int, optional
1316
+ :return: Returns the result object.
1317
+ """ # noqa: E501
1318
+
1319
+ _param = self._get_webhook_serialize(
1320
+ webhook_id=webhook_id,
1321
+ _request_auth=_request_auth,
1322
+ _content_type=_content_type,
1323
+ _headers=_headers,
1324
+ _host_index=_host_index
1325
+ )
1326
+
1327
+ _response_types_map: Dict[str, Optional[str]] = {
1328
+ '200': "DesignerWebhookWebhookDTO",
1329
+ }
1330
+ response_data = self.api_client.call_api(
1331
+ *_param,
1332
+ _request_timeout=_request_timeout
1333
+ )
1334
+ return response_data.response
1335
+
1336
+
1337
+ def _get_webhook_serialize(
1338
+ self,
1339
+ webhook_id,
1340
+ _request_auth,
1341
+ _content_type,
1342
+ _headers,
1343
+ _host_index,
1344
+ ) -> RequestSerialized:
1345
+
1346
+ _host = None
1347
+
1348
+ _collection_formats: Dict[str, str] = {
1349
+ }
1350
+
1351
+ _path_params: Dict[str, str] = {}
1352
+ _query_params: List[Tuple[str, str]] = []
1353
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1354
+ _form_params: List[Tuple[str, str]] = []
1355
+ _files: Dict[
1356
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1357
+ ] = {}
1358
+ _body_params: Optional[bytes] = None
1359
+
1360
+ # process the path parameters
1361
+ if webhook_id is not None:
1362
+ _path_params['webhookId'] = webhook_id
1363
+ # process the query parameters
1364
+ # process the header parameters
1365
+ # process the form parameters
1366
+ # process the body parameter
1367
+
1368
+
1369
+ # set the HTTP header `Accept`
1370
+ if 'Accept' not in _header_params:
1371
+ _header_params['Accept'] = self.api_client.select_header_accept(
1372
+ [
1373
+ 'application/json'
1374
+ ]
1375
+ )
1376
+
1377
+
1378
+ # authentication setting
1379
+ _auth_settings: List[str] = [
1380
+ 'CookieAuth',
1381
+ 'ApiKeyAuth',
1382
+ 'OAuth2Auth',
1383
+ 'OAuth2Auth',
1384
+ 'BearerAuth'
1385
+ ]
1386
+
1387
+ return self.api_client.param_serialize(
1388
+ method='GET',
1389
+ resource_path='/v1beta/op/webhooks/{webhookId}',
1390
+ path_params=_path_params,
1391
+ query_params=_query_params,
1392
+ header_params=_header_params,
1393
+ body=_body_params,
1394
+ post_params=_form_params,
1395
+ files=_files,
1396
+ auth_settings=_auth_settings,
1397
+ collection_formats=_collection_formats,
1398
+ _host=_host,
1399
+ _request_auth=_request_auth
1400
+ )
1401
+
1402
+
1403
+
1404
+
1405
+ @validate_call
1406
+ def send_test_event(
1407
+ self,
1408
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
1409
+ designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO,
1410
+ _request_timeout: Union[
1411
+ None,
1412
+ Annotated[StrictFloat, Field(gt=0)],
1413
+ Tuple[
1414
+ Annotated[StrictFloat, Field(gt=0)],
1415
+ Annotated[StrictFloat, Field(gt=0)]
1416
+ ]
1417
+ ] = None,
1418
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1419
+ _content_type: Optional[StrictStr] = None,
1420
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1421
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1422
+ ) -> DesignerWebhookWebhookMessageResponseDTO:
1423
+ """Test a webhook
1424
+
1425
+ Send a test event to an existing webhook. This validates whether the webhook works. You must specify the webhook ID and an event type. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1426
+
1427
+ :param webhook_id: The unique identifier of the webhook. (required)
1428
+ :type webhook_id: str
1429
+ :param designer_webhook_webhook_event_type_dto: (required)
1430
+ :type designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO
1431
+ :param _request_timeout: timeout setting for this request. If one
1432
+ number provided, it will be total request
1433
+ timeout. It can also be a pair (tuple) of
1434
+ (connection, read) timeouts.
1435
+ :type _request_timeout: int, tuple(int, int), optional
1436
+ :param _request_auth: set to override the auth_settings for an a single
1437
+ request; this effectively ignores the
1438
+ authentication in the spec for a single request.
1439
+ :type _request_auth: dict, optional
1440
+ :param _content_type: force content-type for the request.
1441
+ :type _content_type: str, Optional
1442
+ :param _headers: set to override the headers for a single
1443
+ request; this effectively ignores the headers
1444
+ in the spec for a single request.
1445
+ :type _headers: dict, optional
1446
+ :param _host_index: set to override the host_index for a single
1447
+ request; this effectively ignores the host_index
1448
+ in the spec for a single request.
1449
+ :type _host_index: int, optional
1450
+ :return: Returns the result object.
1451
+ """ # noqa: E501
1452
+
1453
+ _param = self._send_test_event_serialize(
1454
+ webhook_id=webhook_id,
1455
+ designer_webhook_webhook_event_type_dto=designer_webhook_webhook_event_type_dto,
1456
+ _request_auth=_request_auth,
1457
+ _content_type=_content_type,
1458
+ _headers=_headers,
1459
+ _host_index=_host_index
1460
+ )
1461
+
1462
+ _response_types_map: Dict[str, Optional[str]] = {
1463
+ '200': "DesignerWebhookWebhookMessageResponseDTO",
1464
+ }
1465
+ response_data = self.api_client.call_api(
1466
+ *_param,
1467
+ _request_timeout=_request_timeout
1468
+ )
1469
+ response_data.read()
1470
+ return self.api_client.response_deserialize(
1471
+ response_data=response_data,
1472
+ response_types_map=_response_types_map,
1473
+ ).data
1474
+
1475
+
1476
+ @validate_call
1477
+ def send_test_event_with_http_info(
1478
+ self,
1479
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
1480
+ designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO,
1481
+ _request_timeout: Union[
1482
+ None,
1483
+ Annotated[StrictFloat, Field(gt=0)],
1484
+ Tuple[
1485
+ Annotated[StrictFloat, Field(gt=0)],
1486
+ Annotated[StrictFloat, Field(gt=0)]
1487
+ ]
1488
+ ] = None,
1489
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1490
+ _content_type: Optional[StrictStr] = None,
1491
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1492
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1493
+ ) -> ApiResponse[DesignerWebhookWebhookMessageResponseDTO]:
1494
+ """Test a webhook
1495
+
1496
+ Send a test event to an existing webhook. This validates whether the webhook works. You must specify the webhook ID and an event type. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1497
+
1498
+ :param webhook_id: The unique identifier of the webhook. (required)
1499
+ :type webhook_id: str
1500
+ :param designer_webhook_webhook_event_type_dto: (required)
1501
+ :type designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO
1502
+ :param _request_timeout: timeout setting for this request. If one
1503
+ number provided, it will be total request
1504
+ timeout. It can also be a pair (tuple) of
1505
+ (connection, read) timeouts.
1506
+ :type _request_timeout: int, tuple(int, int), optional
1507
+ :param _request_auth: set to override the auth_settings for an a single
1508
+ request; this effectively ignores the
1509
+ authentication in the spec for a single request.
1510
+ :type _request_auth: dict, optional
1511
+ :param _content_type: force content-type for the request.
1512
+ :type _content_type: str, Optional
1513
+ :param _headers: set to override the headers for a single
1514
+ request; this effectively ignores the headers
1515
+ in the spec for a single request.
1516
+ :type _headers: dict, optional
1517
+ :param _host_index: set to override the host_index for a single
1518
+ request; this effectively ignores the host_index
1519
+ in the spec for a single request.
1520
+ :type _host_index: int, optional
1521
+ :return: Returns the result object.
1522
+ """ # noqa: E501
1523
+
1524
+ _param = self._send_test_event_serialize(
1525
+ webhook_id=webhook_id,
1526
+ designer_webhook_webhook_event_type_dto=designer_webhook_webhook_event_type_dto,
1527
+ _request_auth=_request_auth,
1528
+ _content_type=_content_type,
1529
+ _headers=_headers,
1530
+ _host_index=_host_index
1531
+ )
1532
+
1533
+ _response_types_map: Dict[str, Optional[str]] = {
1534
+ '200': "DesignerWebhookWebhookMessageResponseDTO",
1535
+ }
1536
+ response_data = self.api_client.call_api(
1537
+ *_param,
1538
+ _request_timeout=_request_timeout
1539
+ )
1540
+ response_data.read()
1541
+ return self.api_client.response_deserialize(
1542
+ response_data=response_data,
1543
+ response_types_map=_response_types_map,
1544
+ )
1545
+
1546
+
1547
+ @validate_call
1548
+ def send_test_event_without_preload_content(
1549
+ self,
1550
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
1551
+ designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO,
1552
+ _request_timeout: Union[
1553
+ None,
1554
+ Annotated[StrictFloat, Field(gt=0)],
1555
+ Tuple[
1556
+ Annotated[StrictFloat, Field(gt=0)],
1557
+ Annotated[StrictFloat, Field(gt=0)]
1558
+ ]
1559
+ ] = None,
1560
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1561
+ _content_type: Optional[StrictStr] = None,
1562
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1563
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1564
+ ) -> RESTResponseType:
1565
+ """Test a webhook
1566
+
1567
+ Send a test event to an existing webhook. This validates whether the webhook works. You must specify the webhook ID and an event type. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1568
+
1569
+ :param webhook_id: The unique identifier of the webhook. (required)
1570
+ :type webhook_id: str
1571
+ :param designer_webhook_webhook_event_type_dto: (required)
1572
+ :type designer_webhook_webhook_event_type_dto: DesignerWebhookWebhookEventTypeDTO
1573
+ :param _request_timeout: timeout setting for this request. If one
1574
+ number provided, it will be total request
1575
+ timeout. It can also be a pair (tuple) of
1576
+ (connection, read) timeouts.
1577
+ :type _request_timeout: int, tuple(int, int), optional
1578
+ :param _request_auth: set to override the auth_settings for an a single
1579
+ request; this effectively ignores the
1580
+ authentication in the spec for a single request.
1581
+ :type _request_auth: dict, optional
1582
+ :param _content_type: force content-type for the request.
1583
+ :type _content_type: str, Optional
1584
+ :param _headers: set to override the headers for a single
1585
+ request; this effectively ignores the headers
1586
+ in the spec for a single request.
1587
+ :type _headers: dict, optional
1588
+ :param _host_index: set to override the host_index for a single
1589
+ request; this effectively ignores the host_index
1590
+ in the spec for a single request.
1591
+ :type _host_index: int, optional
1592
+ :return: Returns the result object.
1593
+ """ # noqa: E501
1594
+
1595
+ _param = self._send_test_event_serialize(
1596
+ webhook_id=webhook_id,
1597
+ designer_webhook_webhook_event_type_dto=designer_webhook_webhook_event_type_dto,
1598
+ _request_auth=_request_auth,
1599
+ _content_type=_content_type,
1600
+ _headers=_headers,
1601
+ _host_index=_host_index
1602
+ )
1603
+
1604
+ _response_types_map: Dict[str, Optional[str]] = {
1605
+ '200': "DesignerWebhookWebhookMessageResponseDTO",
1606
+ }
1607
+ response_data = self.api_client.call_api(
1608
+ *_param,
1609
+ _request_timeout=_request_timeout
1610
+ )
1611
+ return response_data.response
1612
+
1613
+
1614
+ def _send_test_event_serialize(
1615
+ self,
1616
+ webhook_id,
1617
+ designer_webhook_webhook_event_type_dto,
1618
+ _request_auth,
1619
+ _content_type,
1620
+ _headers,
1621
+ _host_index,
1622
+ ) -> RequestSerialized:
1623
+
1624
+ _host = None
1625
+
1626
+ _collection_formats: Dict[str, str] = {
1627
+ }
1628
+
1629
+ _path_params: Dict[str, str] = {}
1630
+ _query_params: List[Tuple[str, str]] = []
1631
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1632
+ _form_params: List[Tuple[str, str]] = []
1633
+ _files: Dict[
1634
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1635
+ ] = {}
1636
+ _body_params: Optional[bytes] = None
1637
+
1638
+ # process the path parameters
1639
+ if webhook_id is not None:
1640
+ _path_params['webhookId'] = webhook_id
1641
+ # process the query parameters
1642
+ # process the header parameters
1643
+ # process the form parameters
1644
+ # process the body parameter
1645
+ if designer_webhook_webhook_event_type_dto is not None:
1646
+ _body_params = designer_webhook_webhook_event_type_dto
1647
+
1648
+
1649
+ # set the HTTP header `Accept`
1650
+ if 'Accept' not in _header_params:
1651
+ _header_params['Accept'] = self.api_client.select_header_accept(
1652
+ [
1653
+ 'application/json'
1654
+ ]
1655
+ )
1656
+
1657
+ # set the HTTP header `Content-Type`
1658
+ if _content_type:
1659
+ _header_params['Content-Type'] = _content_type
1660
+ else:
1661
+ _default_content_type = (
1662
+ self.api_client.select_header_content_type(
1663
+ [
1664
+ 'application/json'
1665
+ ]
1666
+ )
1667
+ )
1668
+ if _default_content_type is not None:
1669
+ _header_params['Content-Type'] = _default_content_type
1670
+
1671
+ # authentication setting
1672
+ _auth_settings: List[str] = [
1673
+ 'CookieAuth',
1674
+ 'ApiKeyAuth',
1675
+ 'OAuth2Auth',
1676
+ 'OAuth2Auth',
1677
+ 'BearerAuth'
1678
+ ]
1679
+
1680
+ return self.api_client.param_serialize(
1681
+ method='POST',
1682
+ resource_path='/v1beta/op/webhooks/{webhookId}/testEvent',
1683
+ path_params=_path_params,
1684
+ query_params=_query_params,
1685
+ header_params=_header_params,
1686
+ body=_body_params,
1687
+ post_params=_form_params,
1688
+ files=_files,
1689
+ auth_settings=_auth_settings,
1690
+ collection_formats=_collection_formats,
1691
+ _host=_host,
1692
+ _request_auth=_request_auth
1693
+ )
1694
+
1695
+
1696
+
1697
+
1698
+ @validate_call
1699
+ def update_webhook(
1700
+ self,
1701
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
1702
+ designer_webhook_webhook_dto: DesignerWebhookWebhookDTO,
1703
+ _request_timeout: Union[
1704
+ None,
1705
+ Annotated[StrictFloat, Field(gt=0)],
1706
+ Tuple[
1707
+ Annotated[StrictFloat, Field(gt=0)],
1708
+ Annotated[StrictFloat, Field(gt=0)]
1709
+ ]
1710
+ ] = None,
1711
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1712
+ _content_type: Optional[StrictStr] = None,
1713
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1714
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1715
+ ) -> DesignerWebhookWebhookDTO:
1716
+ """Update a webhook's details
1717
+
1718
+ Update the details of an existing webhook, such as its URL and active status. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's credentials, see `PUT /v1beta/op/webhooks/{webhookId}/credentials`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1719
+
1720
+ :param webhook_id: The unique identifier of the webhook. (required)
1721
+ :type webhook_id: str
1722
+ :param designer_webhook_webhook_dto: (required)
1723
+ :type designer_webhook_webhook_dto: DesignerWebhookWebhookDTO
1724
+ :param _request_timeout: timeout setting for this request. If one
1725
+ number provided, it will be total request
1726
+ timeout. It can also be a pair (tuple) of
1727
+ (connection, read) timeouts.
1728
+ :type _request_timeout: int, tuple(int, int), optional
1729
+ :param _request_auth: set to override the auth_settings for an a single
1730
+ request; this effectively ignores the
1731
+ authentication in the spec for a single request.
1732
+ :type _request_auth: dict, optional
1733
+ :param _content_type: force content-type for the request.
1734
+ :type _content_type: str, Optional
1735
+ :param _headers: set to override the headers for a single
1736
+ request; this effectively ignores the headers
1737
+ in the spec for a single request.
1738
+ :type _headers: dict, optional
1739
+ :param _host_index: set to override the host_index for a single
1740
+ request; this effectively ignores the host_index
1741
+ in the spec for a single request.
1742
+ :type _host_index: int, optional
1743
+ :return: Returns the result object.
1744
+ """ # noqa: E501
1745
+
1746
+ _param = self._update_webhook_serialize(
1747
+ webhook_id=webhook_id,
1748
+ designer_webhook_webhook_dto=designer_webhook_webhook_dto,
1749
+ _request_auth=_request_auth,
1750
+ _content_type=_content_type,
1751
+ _headers=_headers,
1752
+ _host_index=_host_index
1753
+ )
1754
+
1755
+ _response_types_map: Dict[str, Optional[str]] = {
1756
+ '200': "DesignerWebhookWebhookDTO",
1757
+ }
1758
+ response_data = self.api_client.call_api(
1759
+ *_param,
1760
+ _request_timeout=_request_timeout
1761
+ )
1762
+ response_data.read()
1763
+ return self.api_client.response_deserialize(
1764
+ response_data=response_data,
1765
+ response_types_map=_response_types_map,
1766
+ ).data
1767
+
1768
+
1769
+ @validate_call
1770
+ def update_webhook_with_http_info(
1771
+ self,
1772
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
1773
+ designer_webhook_webhook_dto: DesignerWebhookWebhookDTO,
1774
+ _request_timeout: Union[
1775
+ None,
1776
+ Annotated[StrictFloat, Field(gt=0)],
1777
+ Tuple[
1778
+ Annotated[StrictFloat, Field(gt=0)],
1779
+ Annotated[StrictFloat, Field(gt=0)]
1780
+ ]
1781
+ ] = None,
1782
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1783
+ _content_type: Optional[StrictStr] = None,
1784
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1785
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1786
+ ) -> ApiResponse[DesignerWebhookWebhookDTO]:
1787
+ """Update a webhook's details
1788
+
1789
+ Update the details of an existing webhook, such as its URL and active status. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's credentials, see `PUT /v1beta/op/webhooks/{webhookId}/credentials`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1790
+
1791
+ :param webhook_id: The unique identifier of the webhook. (required)
1792
+ :type webhook_id: str
1793
+ :param designer_webhook_webhook_dto: (required)
1794
+ :type designer_webhook_webhook_dto: DesignerWebhookWebhookDTO
1795
+ :param _request_timeout: timeout setting for this request. If one
1796
+ number provided, it will be total request
1797
+ timeout. It can also be a pair (tuple) of
1798
+ (connection, read) timeouts.
1799
+ :type _request_timeout: int, tuple(int, int), optional
1800
+ :param _request_auth: set to override the auth_settings for an a single
1801
+ request; this effectively ignores the
1802
+ authentication in the spec for a single request.
1803
+ :type _request_auth: dict, optional
1804
+ :param _content_type: force content-type for the request.
1805
+ :type _content_type: str, Optional
1806
+ :param _headers: set to override the headers for a single
1807
+ request; this effectively ignores the headers
1808
+ in the spec for a single request.
1809
+ :type _headers: dict, optional
1810
+ :param _host_index: set to override the host_index for a single
1811
+ request; this effectively ignores the host_index
1812
+ in the spec for a single request.
1813
+ :type _host_index: int, optional
1814
+ :return: Returns the result object.
1815
+ """ # noqa: E501
1816
+
1817
+ _param = self._update_webhook_serialize(
1818
+ webhook_id=webhook_id,
1819
+ designer_webhook_webhook_dto=designer_webhook_webhook_dto,
1820
+ _request_auth=_request_auth,
1821
+ _content_type=_content_type,
1822
+ _headers=_headers,
1823
+ _host_index=_host_index
1824
+ )
1825
+
1826
+ _response_types_map: Dict[str, Optional[str]] = {
1827
+ '200': "DesignerWebhookWebhookDTO",
1828
+ }
1829
+ response_data = self.api_client.call_api(
1830
+ *_param,
1831
+ _request_timeout=_request_timeout
1832
+ )
1833
+ response_data.read()
1834
+ return self.api_client.response_deserialize(
1835
+ response_data=response_data,
1836
+ response_types_map=_response_types_map,
1837
+ )
1838
+
1839
+
1840
+ @validate_call
1841
+ def update_webhook_without_preload_content(
1842
+ self,
1843
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
1844
+ designer_webhook_webhook_dto: DesignerWebhookWebhookDTO,
1845
+ _request_timeout: Union[
1846
+ None,
1847
+ Annotated[StrictFloat, Field(gt=0)],
1848
+ Tuple[
1849
+ Annotated[StrictFloat, Field(gt=0)],
1850
+ Annotated[StrictFloat, Field(gt=0)]
1851
+ ]
1852
+ ] = None,
1853
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1854
+ _content_type: Optional[StrictStr] = None,
1855
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1856
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1857
+ ) -> RESTResponseType:
1858
+ """Update a webhook's details
1859
+
1860
+ Update the details of an existing webhook, such as its URL and active status. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's credentials, see `PUT /v1beta/op/webhooks/{webhookId}/credentials`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
1861
+
1862
+ :param webhook_id: The unique identifier of the webhook. (required)
1863
+ :type webhook_id: str
1864
+ :param designer_webhook_webhook_dto: (required)
1865
+ :type designer_webhook_webhook_dto: DesignerWebhookWebhookDTO
1866
+ :param _request_timeout: timeout setting for this request. If one
1867
+ number provided, it will be total request
1868
+ timeout. It can also be a pair (tuple) of
1869
+ (connection, read) timeouts.
1870
+ :type _request_timeout: int, tuple(int, int), optional
1871
+ :param _request_auth: set to override the auth_settings for an a single
1872
+ request; this effectively ignores the
1873
+ authentication in the spec for a single request.
1874
+ :type _request_auth: dict, optional
1875
+ :param _content_type: force content-type for the request.
1876
+ :type _content_type: str, Optional
1877
+ :param _headers: set to override the headers for a single
1878
+ request; this effectively ignores the headers
1879
+ in the spec for a single request.
1880
+ :type _headers: dict, optional
1881
+ :param _host_index: set to override the host_index for a single
1882
+ request; this effectively ignores the host_index
1883
+ in the spec for a single request.
1884
+ :type _host_index: int, optional
1885
+ :return: Returns the result object.
1886
+ """ # noqa: E501
1887
+
1888
+ _param = self._update_webhook_serialize(
1889
+ webhook_id=webhook_id,
1890
+ designer_webhook_webhook_dto=designer_webhook_webhook_dto,
1891
+ _request_auth=_request_auth,
1892
+ _content_type=_content_type,
1893
+ _headers=_headers,
1894
+ _host_index=_host_index
1895
+ )
1896
+
1897
+ _response_types_map: Dict[str, Optional[str]] = {
1898
+ '200': "DesignerWebhookWebhookDTO",
1899
+ }
1900
+ response_data = self.api_client.call_api(
1901
+ *_param,
1902
+ _request_timeout=_request_timeout
1903
+ )
1904
+ return response_data.response
1905
+
1906
+
1907
+ def _update_webhook_serialize(
1908
+ self,
1909
+ webhook_id,
1910
+ designer_webhook_webhook_dto,
1911
+ _request_auth,
1912
+ _content_type,
1913
+ _headers,
1914
+ _host_index,
1915
+ ) -> RequestSerialized:
1916
+
1917
+ _host = None
1918
+
1919
+ _collection_formats: Dict[str, str] = {
1920
+ }
1921
+
1922
+ _path_params: Dict[str, str] = {}
1923
+ _query_params: List[Tuple[str, str]] = []
1924
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1925
+ _form_params: List[Tuple[str, str]] = []
1926
+ _files: Dict[
1927
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1928
+ ] = {}
1929
+ _body_params: Optional[bytes] = None
1930
+
1931
+ # process the path parameters
1932
+ if webhook_id is not None:
1933
+ _path_params['webhookId'] = webhook_id
1934
+ # process the query parameters
1935
+ # process the header parameters
1936
+ # process the form parameters
1937
+ # process the body parameter
1938
+ if designer_webhook_webhook_dto is not None:
1939
+ _body_params = designer_webhook_webhook_dto
1940
+
1941
+
1942
+ # set the HTTP header `Accept`
1943
+ if 'Accept' not in _header_params:
1944
+ _header_params['Accept'] = self.api_client.select_header_accept(
1945
+ [
1946
+ 'application/json'
1947
+ ]
1948
+ )
1949
+
1950
+ # set the HTTP header `Content-Type`
1951
+ if _content_type:
1952
+ _header_params['Content-Type'] = _content_type
1953
+ else:
1954
+ _default_content_type = (
1955
+ self.api_client.select_header_content_type(
1956
+ [
1957
+ 'application/json'
1958
+ ]
1959
+ )
1960
+ )
1961
+ if _default_content_type is not None:
1962
+ _header_params['Content-Type'] = _default_content_type
1963
+
1964
+ # authentication setting
1965
+ _auth_settings: List[str] = [
1966
+ 'CookieAuth',
1967
+ 'ApiKeyAuth',
1968
+ 'OAuth2Auth',
1969
+ 'OAuth2Auth',
1970
+ 'BearerAuth'
1971
+ ]
1972
+
1973
+ return self.api_client.param_serialize(
1974
+ method='PUT',
1975
+ resource_path='/v1beta/op/webhooks/{webhookId}',
1976
+ path_params=_path_params,
1977
+ query_params=_query_params,
1978
+ header_params=_header_params,
1979
+ body=_body_params,
1980
+ post_params=_form_params,
1981
+ files=_files,
1982
+ auth_settings=_auth_settings,
1983
+ collection_formats=_collection_formats,
1984
+ _host=_host,
1985
+ _request_auth=_request_auth
1986
+ )
1987
+
1988
+
1989
+
1990
+
1991
+ @validate_call
1992
+ def update_webhook_credentials(
1993
+ self,
1994
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
1995
+ designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO,
1996
+ _request_timeout: Union[
1997
+ None,
1998
+ Annotated[StrictFloat, Field(gt=0)],
1999
+ Tuple[
2000
+ Annotated[StrictFloat, Field(gt=0)],
2001
+ Annotated[StrictFloat, Field(gt=0)]
2002
+ ]
2003
+ ] = None,
2004
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2005
+ _content_type: Optional[StrictStr] = None,
2006
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2007
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2008
+ ) -> DesignerWebhookWebhookDTO:
2009
+ """Update a webhook's credentials
2010
+
2011
+ Update the credentials to authenticate calls to the webhook endpoint. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's details, see `PUT /v1beta/op/webhooks/{webhookId}`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
2012
+
2013
+ :param webhook_id: The unique identifier of the webhook. (required)
2014
+ :type webhook_id: str
2015
+ :param designer_webhook_webhook_credentials_dto: (required)
2016
+ :type designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO
2017
+ :param _request_timeout: timeout setting for this request. If one
2018
+ number provided, it will be total request
2019
+ timeout. It can also be a pair (tuple) of
2020
+ (connection, read) timeouts.
2021
+ :type _request_timeout: int, tuple(int, int), optional
2022
+ :param _request_auth: set to override the auth_settings for an a single
2023
+ request; this effectively ignores the
2024
+ authentication in the spec for a single request.
2025
+ :type _request_auth: dict, optional
2026
+ :param _content_type: force content-type for the request.
2027
+ :type _content_type: str, Optional
2028
+ :param _headers: set to override the headers for a single
2029
+ request; this effectively ignores the headers
2030
+ in the spec for a single request.
2031
+ :type _headers: dict, optional
2032
+ :param _host_index: set to override the host_index for a single
2033
+ request; this effectively ignores the host_index
2034
+ in the spec for a single request.
2035
+ :type _host_index: int, optional
2036
+ :return: Returns the result object.
2037
+ """ # noqa: E501
2038
+
2039
+ _param = self._update_webhook_credentials_serialize(
2040
+ webhook_id=webhook_id,
2041
+ designer_webhook_webhook_credentials_dto=designer_webhook_webhook_credentials_dto,
2042
+ _request_auth=_request_auth,
2043
+ _content_type=_content_type,
2044
+ _headers=_headers,
2045
+ _host_index=_host_index
2046
+ )
2047
+
2048
+ _response_types_map: Dict[str, Optional[str]] = {
2049
+ '200': "DesignerWebhookWebhookDTO",
2050
+ }
2051
+ response_data = self.api_client.call_api(
2052
+ *_param,
2053
+ _request_timeout=_request_timeout
2054
+ )
2055
+ response_data.read()
2056
+ return self.api_client.response_deserialize(
2057
+ response_data=response_data,
2058
+ response_types_map=_response_types_map,
2059
+ ).data
2060
+
2061
+
2062
+ @validate_call
2063
+ def update_webhook_credentials_with_http_info(
2064
+ self,
2065
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
2066
+ designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO,
2067
+ _request_timeout: Union[
2068
+ None,
2069
+ Annotated[StrictFloat, Field(gt=0)],
2070
+ Tuple[
2071
+ Annotated[StrictFloat, Field(gt=0)],
2072
+ Annotated[StrictFloat, Field(gt=0)]
2073
+ ]
2074
+ ] = None,
2075
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2076
+ _content_type: Optional[StrictStr] = None,
2077
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2078
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2079
+ ) -> ApiResponse[DesignerWebhookWebhookDTO]:
2080
+ """Update a webhook's credentials
2081
+
2082
+ Update the credentials to authenticate calls to the webhook endpoint. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's details, see `PUT /v1beta/op/webhooks/{webhookId}`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
2083
+
2084
+ :param webhook_id: The unique identifier of the webhook. (required)
2085
+ :type webhook_id: str
2086
+ :param designer_webhook_webhook_credentials_dto: (required)
2087
+ :type designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO
2088
+ :param _request_timeout: timeout setting for this request. If one
2089
+ number provided, it will be total request
2090
+ timeout. It can also be a pair (tuple) of
2091
+ (connection, read) timeouts.
2092
+ :type _request_timeout: int, tuple(int, int), optional
2093
+ :param _request_auth: set to override the auth_settings for an a single
2094
+ request; this effectively ignores the
2095
+ authentication in the spec for a single request.
2096
+ :type _request_auth: dict, optional
2097
+ :param _content_type: force content-type for the request.
2098
+ :type _content_type: str, Optional
2099
+ :param _headers: set to override the headers for a single
2100
+ request; this effectively ignores the headers
2101
+ in the spec for a single request.
2102
+ :type _headers: dict, optional
2103
+ :param _host_index: set to override the host_index for a single
2104
+ request; this effectively ignores the host_index
2105
+ in the spec for a single request.
2106
+ :type _host_index: int, optional
2107
+ :return: Returns the result object.
2108
+ """ # noqa: E501
2109
+
2110
+ _param = self._update_webhook_credentials_serialize(
2111
+ webhook_id=webhook_id,
2112
+ designer_webhook_webhook_credentials_dto=designer_webhook_webhook_credentials_dto,
2113
+ _request_auth=_request_auth,
2114
+ _content_type=_content_type,
2115
+ _headers=_headers,
2116
+ _host_index=_host_index
2117
+ )
2118
+
2119
+ _response_types_map: Dict[str, Optional[str]] = {
2120
+ '200': "DesignerWebhookWebhookDTO",
2121
+ }
2122
+ response_data = self.api_client.call_api(
2123
+ *_param,
2124
+ _request_timeout=_request_timeout
2125
+ )
2126
+ response_data.read()
2127
+ return self.api_client.response_deserialize(
2128
+ response_data=response_data,
2129
+ response_types_map=_response_types_map,
2130
+ )
2131
+
2132
+
2133
+ @validate_call
2134
+ def update_webhook_credentials_without_preload_content(
2135
+ self,
2136
+ webhook_id: Annotated[StrictStr, Field(description="The unique identifier of the webhook.")],
2137
+ designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO,
2138
+ _request_timeout: Union[
2139
+ None,
2140
+ Annotated[StrictFloat, Field(gt=0)],
2141
+ Tuple[
2142
+ Annotated[StrictFloat, Field(gt=0)],
2143
+ Annotated[StrictFloat, Field(gt=0)]
2144
+ ]
2145
+ ] = None,
2146
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2147
+ _content_type: Optional[StrictStr] = None,
2148
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2149
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2150
+ ) -> RESTResponseType:
2151
+ """Update a webhook's credentials
2152
+
2153
+ Update the credentials to authenticate calls to the webhook endpoint. You must know the ID of the webhook to update it. To retrieve webhook IDs, see `GET /v1beta/op/webhooks`. To update a webhook's details, see `PUT /v1beta/op/webhooks/{webhookId}`. When updating a webhook, the webhook definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the webhook. We recommend that you retrieve a webhook's details before you update the webhook with new values. <br>**Note:** <em>This API is in **beta**. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
2154
+
2155
+ :param webhook_id: The unique identifier of the webhook. (required)
2156
+ :type webhook_id: str
2157
+ :param designer_webhook_webhook_credentials_dto: (required)
2158
+ :type designer_webhook_webhook_credentials_dto: DesignerWebhookWebhookCredentialsDTO
2159
+ :param _request_timeout: timeout setting for this request. If one
2160
+ number provided, it will be total request
2161
+ timeout. It can also be a pair (tuple) of
2162
+ (connection, read) timeouts.
2163
+ :type _request_timeout: int, tuple(int, int), optional
2164
+ :param _request_auth: set to override the auth_settings for an a single
2165
+ request; this effectively ignores the
2166
+ authentication in the spec for a single request.
2167
+ :type _request_auth: dict, optional
2168
+ :param _content_type: force content-type for the request.
2169
+ :type _content_type: str, Optional
2170
+ :param _headers: set to override the headers for a single
2171
+ request; this effectively ignores the headers
2172
+ in the spec for a single request.
2173
+ :type _headers: dict, optional
2174
+ :param _host_index: set to override the host_index for a single
2175
+ request; this effectively ignores the host_index
2176
+ in the spec for a single request.
2177
+ :type _host_index: int, optional
2178
+ :return: Returns the result object.
2179
+ """ # noqa: E501
2180
+
2181
+ _param = self._update_webhook_credentials_serialize(
2182
+ webhook_id=webhook_id,
2183
+ designer_webhook_webhook_credentials_dto=designer_webhook_webhook_credentials_dto,
2184
+ _request_auth=_request_auth,
2185
+ _content_type=_content_type,
2186
+ _headers=_headers,
2187
+ _host_index=_host_index
2188
+ )
2189
+
2190
+ _response_types_map: Dict[str, Optional[str]] = {
2191
+ '200': "DesignerWebhookWebhookDTO",
2192
+ }
2193
+ response_data = self.api_client.call_api(
2194
+ *_param,
2195
+ _request_timeout=_request_timeout
2196
+ )
2197
+ return response_data.response
2198
+
2199
+
2200
+ def _update_webhook_credentials_serialize(
2201
+ self,
2202
+ webhook_id,
2203
+ designer_webhook_webhook_credentials_dto,
2204
+ _request_auth,
2205
+ _content_type,
2206
+ _headers,
2207
+ _host_index,
2208
+ ) -> RequestSerialized:
2209
+
2210
+ _host = None
2211
+
2212
+ _collection_formats: Dict[str, str] = {
2213
+ }
2214
+
2215
+ _path_params: Dict[str, str] = {}
2216
+ _query_params: List[Tuple[str, str]] = []
2217
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2218
+ _form_params: List[Tuple[str, str]] = []
2219
+ _files: Dict[
2220
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2221
+ ] = {}
2222
+ _body_params: Optional[bytes] = None
2223
+
2224
+ # process the path parameters
2225
+ if webhook_id is not None:
2226
+ _path_params['webhookId'] = webhook_id
2227
+ # process the query parameters
2228
+ # process the header parameters
2229
+ # process the form parameters
2230
+ # process the body parameter
2231
+ if designer_webhook_webhook_credentials_dto is not None:
2232
+ _body_params = designer_webhook_webhook_credentials_dto
2233
+
2234
+
2235
+ # set the HTTP header `Accept`
2236
+ if 'Accept' not in _header_params:
2237
+ _header_params['Accept'] = self.api_client.select_header_accept(
2238
+ [
2239
+ 'application/json'
2240
+ ]
2241
+ )
2242
+
2243
+ # set the HTTP header `Content-Type`
2244
+ if _content_type:
2245
+ _header_params['Content-Type'] = _content_type
2246
+ else:
2247
+ _default_content_type = (
2248
+ self.api_client.select_header_content_type(
2249
+ [
2250
+ 'application/json'
2251
+ ]
2252
+ )
2253
+ )
2254
+ if _default_content_type is not None:
2255
+ _header_params['Content-Type'] = _default_content_type
2256
+
2257
+ # authentication setting
2258
+ _auth_settings: List[str] = [
2259
+ 'CookieAuth',
2260
+ 'ApiKeyAuth',
2261
+ 'OAuth2Auth',
2262
+ 'OAuth2Auth',
2263
+ 'BearerAuth'
2264
+ ]
2265
+
2266
+ return self.api_client.param_serialize(
2267
+ method='PUT',
2268
+ resource_path='/v1beta/op/webhooks/{webhookId}/credentials',
2269
+ path_params=_path_params,
2270
+ query_params=_query_params,
2271
+ header_params=_header_params,
2272
+ body=_body_params,
2273
+ post_params=_form_params,
2274
+ files=_files,
2275
+ auth_settings=_auth_settings,
2276
+ collection_formats=_collection_formats,
2277
+ _host=_host,
2278
+ _request_auth=_request_auth
2279
+ )
2280
+
2281
+