visier-platform-sdk 22222222.99200.21494__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of visier-platform-sdk might be problematic. Click here for more details.

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