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

visier_platform_sdk/api/dimensions_api.py

@@ -5,7 +5,7 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99200.21494
+    The version of the OpenAPI document: 22222222.99200.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -20,6 +20,8 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictBool, StrictInt, StrictStr
 from typing import List, Optional
 from typing_extensions import Annotated
+from visier_platform_sdk.models.career_level_search_input import CareerLevelSearchInput
+from visier_platform_sdk.models.career_level_search_output import CareerLevelSearchOutput
 from visier_platform_sdk.models.dimension_member import DimensionMember
 from visier_platform_sdk.models.hierarchy import Hierarchy
 from visier_platform_sdk.models.job_feedback_input import JobFeedbackInput
@@ -53,6 +55,7 @@ class DimensionsApi:
         self,
         job: Annotated[Optional[StrictStr], Field(description="The job member ID.  If provided, the response returns the members for the job. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -74,6 +77,8 @@ class DimensionsApi:
         :type job: str
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -99,6 +104,7 @@ class DimensionsApi:
         _param = self._get_career_levels_serialize(
             job=job,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -127,6 +133,7 @@ class DimensionsApi:
         self,
         job: Annotated[Optional[StrictStr], Field(description="The job member ID.  If provided, the response returns the members for the job. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -148,6 +155,8 @@ class DimensionsApi:
         :type job: str
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -173,6 +182,7 @@ class DimensionsApi:
         _param = self._get_career_levels_serialize(
             job=job,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -201,6 +211,7 @@ class DimensionsApi:
         self,
         job: Annotated[Optional[StrictStr], Field(description="The job member ID.  If provided, the response returns the members for the job. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -222,6 +233,8 @@ class DimensionsApi:
         :type job: str
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -247,6 +260,7 @@ class DimensionsApi:
         _param = self._get_career_levels_serialize(
             job=job,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -270,6 +284,7 @@ class DimensionsApi:
         self,
         job,
         has_benchmark_value,
+        include_archived,
         _request_auth,
         _content_type,
         _headers,
@@ -300,6 +315,10 @@ class DimensionsApi:
             
             _query_params.append(('hasBenchmarkValue', has_benchmark_value))
             
+        if include_archived is not None:
+            
+            _query_params.append(('includeArchived', include_archived))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -342,6 +361,7 @@ class DimensionsApi:
         self,
         headcount: Annotated[Optional[StrictInt], Field(description="The number of employees.  If provided, the response returns the members with the same headcount. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -363,6 +383,8 @@ class DimensionsApi:
         :type headcount: int
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -388,6 +410,7 @@ class DimensionsApi:
         _param = self._get_company_sizes_serialize(
             headcount=headcount,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -416,6 +439,7 @@ class DimensionsApi:
         self,
         headcount: Annotated[Optional[StrictInt], Field(description="The number of employees.  If provided, the response returns the members with the same headcount. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -437,6 +461,8 @@ class DimensionsApi:
         :type headcount: int
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -462,6 +488,7 @@ class DimensionsApi:
         _param = self._get_company_sizes_serialize(
             headcount=headcount,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -490,6 +517,7 @@ class DimensionsApi:
         self,
         headcount: Annotated[Optional[StrictInt], Field(description="The number of employees.  If provided, the response returns the members with the same headcount. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -511,6 +539,8 @@ class DimensionsApi:
         :type headcount: int
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -536,6 +566,7 @@ class DimensionsApi:
         _param = self._get_company_sizes_serialize(
             headcount=headcount,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -559,6 +590,7 @@ class DimensionsApi:
         self,
         headcount,
         has_benchmark_value,
+        include_archived,
         _request_auth,
         _content_type,
         _headers,
@@ -589,6 +621,10 @@ class DimensionsApi:
             
             _query_params.append(('hasBenchmarkValue', has_benchmark_value))
             
+        if include_archived is not None:
+            
+            _query_params.append(('includeArchived', include_archived))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -631,7 +667,9 @@ class DimensionsApi:
         self,
         parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member.  If the ID is provided, the response returns the immediate children of the parent member.  To get the top-level members, use the value `root`. ")] = None,
         naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code.  If provided, the response returns the best matching member associated with the code. ")] = None,
+        show_hierarchy: Annotated[Optional[StrictBool], Field(description="If `true`, returns members in a tree structure based on the industry hierarchy. Default is `false`. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -653,8 +691,12 @@ class DimensionsApi:
         :type parent: str
         :param naics_code: The North American Industry Classification System (NAICS) code.  If provided, the response returns the best matching member associated with the code. 
         :type naics_code: str
+        :param show_hierarchy: If `true`, returns members in a tree structure based on the industry hierarchy. Default is `false`. 
+        :type show_hierarchy: bool
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -680,7 +722,9 @@ class DimensionsApi:
         _param = self._get_industries_serialize(
             parent=parent,
             naics_code=naics_code,
+            show_hierarchy=show_hierarchy,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -709,7 +753,9 @@ class DimensionsApi:
         self,
         parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member.  If the ID is provided, the response returns the immediate children of the parent member.  To get the top-level members, use the value `root`. ")] = None,
         naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code.  If provided, the response returns the best matching member associated with the code. ")] = None,
+        show_hierarchy: Annotated[Optional[StrictBool], Field(description="If `true`, returns members in a tree structure based on the industry hierarchy. Default is `false`. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -731,8 +777,12 @@ class DimensionsApi:
         :type parent: str
         :param naics_code: The North American Industry Classification System (NAICS) code.  If provided, the response returns the best matching member associated with the code. 
         :type naics_code: str
+        :param show_hierarchy: If `true`, returns members in a tree structure based on the industry hierarchy. Default is `false`. 
+        :type show_hierarchy: bool
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -758,7 +808,9 @@ class DimensionsApi:
         _param = self._get_industries_serialize(
             parent=parent,
             naics_code=naics_code,
+            show_hierarchy=show_hierarchy,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -787,7 +839,9 @@ class DimensionsApi:
         self,
         parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member.  If the ID is provided, the response returns the immediate children of the parent member.  To get the top-level members, use the value `root`. ")] = None,
         naics_code: Annotated[Optional[StrictStr], Field(description="The North American Industry Classification System (NAICS) code.  If provided, the response returns the best matching member associated with the code. ")] = None,
+        show_hierarchy: Annotated[Optional[StrictBool], Field(description="If `true`, returns members in a tree structure based on the industry hierarchy. Default is `false`. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -809,8 +863,12 @@ class DimensionsApi:
         :type parent: str
         :param naics_code: The North American Industry Classification System (NAICS) code.  If provided, the response returns the best matching member associated with the code. 
         :type naics_code: str
+        :param show_hierarchy: If `true`, returns members in a tree structure based on the industry hierarchy. Default is `false`. 
+        :type show_hierarchy: bool
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -836,7 +894,9 @@ class DimensionsApi:
         _param = self._get_industries_serialize(
             parent=parent,
             naics_code=naics_code,
+            show_hierarchy=show_hierarchy,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -860,7 +920,9 @@ class DimensionsApi:
         self,
         parent,
         naics_code,
+        show_hierarchy,
         has_benchmark_value,
+        include_archived,
         _request_auth,
         _content_type,
         _headers,
@@ -891,10 +953,18 @@ class DimensionsApi:
             
             _query_params.append(('naicsCode', naics_code))
             
+        if show_hierarchy is not None:
+            
+            _query_params.append(('showHierarchy', show_hierarchy))
+            
         if has_benchmark_value is not None:
             
             _query_params.append(('hasBenchmarkValue', has_benchmark_value))
             
+        if include_archived is not None:
+            
+            _query_params.append(('includeArchived', include_archived))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1215,6 +1285,8 @@ class DimensionsApi:
         semantic_only: Annotated[Optional[StrictBool], Field(description="If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None,
         lexical_only: Annotated[Optional[StrictBool], Field(description="If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`.  Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None,
         typical_titles_search: Annotated[Optional[StrictBool], Field(description="If `true`, similar job titles for a job member are included in the lexical search for matches. Default is `false`. ")] = None,
+        show_hierarchy: Annotated[Optional[StrictBool], Field(description="If `true`, returns members in a tree structure based on the occupation hierarchy. Default is `false`. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1248,6 +1320,10 @@ class DimensionsApi:
         :type lexical_only: bool
         :param typical_titles_search: If `true`, similar job titles for a job member are included in the lexical search for matches. Default is `false`. 
         :type typical_titles_search: bool
+        :param show_hierarchy: If `true`, returns members in a tree structure based on the occupation hierarchy. Default is `false`. 
+        :type show_hierarchy: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1279,6 +1355,8 @@ class DimensionsApi:
             semantic_only=semantic_only,
             lexical_only=lexical_only,
             typical_titles_search=typical_titles_search,
+            show_hierarchy=show_hierarchy,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1313,6 +1391,8 @@ class DimensionsApi:
         semantic_only: Annotated[Optional[StrictBool], Field(description="If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None,
         lexical_only: Annotated[Optional[StrictBool], Field(description="If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`.  Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None,
         typical_titles_search: Annotated[Optional[StrictBool], Field(description="If `true`, similar job titles for a job member are included in the lexical search for matches. Default is `false`. ")] = None,
+        show_hierarchy: Annotated[Optional[StrictBool], Field(description="If `true`, returns members in a tree structure based on the occupation hierarchy. Default is `false`. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1346,6 +1426,10 @@ class DimensionsApi:
         :type lexical_only: bool
         :param typical_titles_search: If `true`, similar job titles for a job member are included in the lexical search for matches. Default is `false`. 
         :type typical_titles_search: bool
+        :param show_hierarchy: If `true`, returns members in a tree structure based on the occupation hierarchy. Default is `false`. 
+        :type show_hierarchy: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1377,6 +1461,8 @@ class DimensionsApi:
             semantic_only=semantic_only,
             lexical_only=lexical_only,
             typical_titles_search=typical_titles_search,
+            show_hierarchy=show_hierarchy,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1411,6 +1497,8 @@ class DimensionsApi:
         semantic_only: Annotated[Optional[StrictBool], Field(description="If `true`, only semantic search will be used to find matches. Ensure the parameter `lexicalOnly` is set to `false`. Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None,
         lexical_only: Annotated[Optional[StrictBool], Field(description="If `true`, only lexical search will be used to find matches. Ensure the parameter `semanticOnly` is set to `false`.  Default is `false`. By default, both semantic and lexical search are used to find matches. ")] = None,
         typical_titles_search: Annotated[Optional[StrictBool], Field(description="If `true`, similar job titles for a job member are included in the lexical search for matches. Default is `false`. ")] = None,
+        show_hierarchy: Annotated[Optional[StrictBool], Field(description="If `true`, returns members in a tree structure based on the occupation hierarchy. Default is `false`. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1444,6 +1532,10 @@ class DimensionsApi:
         :type lexical_only: bool
         :param typical_titles_search: If `true`, similar job titles for a job member are included in the lexical search for matches. Default is `false`. 
         :type typical_titles_search: bool
+        :param show_hierarchy: If `true`, returns members in a tree structure based on the occupation hierarchy. Default is `false`. 
+        :type show_hierarchy: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1475,6 +1567,8 @@ class DimensionsApi:
             semantic_only=semantic_only,
             lexical_only=lexical_only,
             typical_titles_search=typical_titles_search,
+            show_hierarchy=show_hierarchy,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1504,6 +1598,8 @@ class DimensionsApi:
         semantic_only,
         lexical_only,
         typical_titles_search,
+        show_hierarchy,
+        include_archived,
         _request_auth,
         _content_type,
         _headers,
@@ -1558,6 +1654,14 @@ class DimensionsApi:
             
             _query_params.append(('typicalTitlesSearch', typical_titles_search))
             
+        if show_hierarchy is not None:
+            
+            _query_params.append(('showHierarchy', show_hierarchy))
+            
+        if include_archived is not None:
+            
+            _query_params.append(('includeArchived', include_archived))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1601,7 +1705,9 @@ class DimensionsApi:
         parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member.  If the ID is provided, the response returns the immediate children of the parent member.  To get the top-level member, use the value `root`. ")] = None,
         country_code: Annotated[Optional[StrictStr], Field(description="The **ISO 3166-1** country code to look up. Returns location members that match the country code.  Currently, the only supported country code is `US`. ")] = None,
         postal_code: Annotated[Optional[StrictStr], Field(description="Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. ")] = None,
+        show_hierarchy: Annotated[Optional[StrictBool], Field(description="If `true`, returns members in a tree structure based on the location hierarchy. Default is `false`. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1625,8 +1731,12 @@ class DimensionsApi:
         :type country_code: str
         :param postal_code: Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. 
         :type postal_code: str
+        :param show_hierarchy: If `true`, returns members in a tree structure based on the location hierarchy. Default is `false`. 
+        :type show_hierarchy: bool
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1653,7 +1763,9 @@ class DimensionsApi:
             parent=parent,
             country_code=country_code,
             postal_code=postal_code,
+            show_hierarchy=show_hierarchy,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1683,7 +1795,9 @@ class DimensionsApi:
         parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member.  If the ID is provided, the response returns the immediate children of the parent member.  To get the top-level member, use the value `root`. ")] = None,
         country_code: Annotated[Optional[StrictStr], Field(description="The **ISO 3166-1** country code to look up. Returns location members that match the country code.  Currently, the only supported country code is `US`. ")] = None,
         postal_code: Annotated[Optional[StrictStr], Field(description="Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. ")] = None,
+        show_hierarchy: Annotated[Optional[StrictBool], Field(description="If `true`, returns members in a tree structure based on the location hierarchy. Default is `false`. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1707,8 +1821,12 @@ class DimensionsApi:
         :type country_code: str
         :param postal_code: Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. 
         :type postal_code: str
+        :param show_hierarchy: If `true`, returns members in a tree structure based on the location hierarchy. Default is `false`. 
+        :type show_hierarchy: bool
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1735,7 +1853,9 @@ class DimensionsApi:
             parent=parent,
             country_code=country_code,
             postal_code=postal_code,
+            show_hierarchy=show_hierarchy,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1765,7 +1885,9 @@ class DimensionsApi:
         parent: Annotated[Optional[StrictStr], Field(description="The ID of the parent member.  If the ID is provided, the response returns the immediate children of the parent member.  To get the top-level member, use the value `root`. ")] = None,
         country_code: Annotated[Optional[StrictStr], Field(description="The **ISO 3166-1** country code to look up. Returns location members that match the country code.  Currently, the only supported country code is `US`. ")] = None,
         postal_code: Annotated[Optional[StrictStr], Field(description="Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. ")] = None,
+        show_hierarchy: Annotated[Optional[StrictBool], Field(description="If `true`, returns members in a tree structure based on the location hierarchy. Default is `false`. ")] = None,
         has_benchmark_value: Annotated[Optional[StrictBool], Field(description="Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. ")] = None,
+        include_archived: Annotated[Optional[StrictBool], Field(description="If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1789,8 +1911,12 @@ class DimensionsApi:
         :type country_code: str
         :param postal_code: Postal code to look up. If `postalCode` is provided, `countryCode` is required. Returns location members that match both the country code and postal code. 
         :type postal_code: str
+        :param show_hierarchy: If `true`, returns members in a tree structure based on the location hierarchy. Default is `false`. 
+        :type show_hierarchy: bool
         :param has_benchmark_value: Filter members based on the availability of benchmark values.  If `true`, members with benchmark values are returned.  If `false`, members without benchmark values are returned.  If no value is specified, all members are returned. 
         :type has_benchmark_value: bool
+        :param include_archived: If `true`, both `active` and `archived` members are returned. Default is `false`. Members are archived when taxonomy changes are made. 
+        :type include_archived: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1817,7 +1943,9 @@ class DimensionsApi:
             parent=parent,
             country_code=country_code,
             postal_code=postal_code,
+            show_hierarchy=show_hierarchy,
             has_benchmark_value=has_benchmark_value,
+            include_archived=include_archived,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1842,7 +1970,9 @@ class DimensionsApi:
         parent,
         country_code,
         postal_code,
+        show_hierarchy,
         has_benchmark_value,
+        include_archived,
         _request_auth,
         _content_type,
         _headers,
@@ -1877,10 +2007,18 @@ class DimensionsApi:
             
             _query_params.append(('postalCode', postal_code))
             
+        if show_hierarchy is not None:
+            
+            _query_params.append(('showHierarchy', show_hierarchy))
+            
         if has_benchmark_value is not None:
             
             _query_params.append(('hasBenchmarkValue', has_benchmark_value))
             
+        if include_archived is not None:
+            
+            _query_params.append(('includeArchived', include_archived))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1918,6 +2056,289 @@ class DimensionsApi:
 
 
 
+    @validate_call
+    def search_career_levels_in_bulk(
+        self,
+        career_level_search_input: Annotated[CareerLevelSearchInput, Field(description="A list of requests that contain job IDs to look up. Returns career levels that match.  Include the mandatory `jobIDs` field. ")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> CareerLevelSearchOutput:
+        """Get career level members in bulk
+
+        Retrieve career level members in bulk by job IDs. 
+
+        :param career_level_search_input: A list of requests that contain job IDs to look up. Returns career levels that match.  Include the mandatory `jobIDs` field.  (required)
+        :type career_level_search_input: CareerLevelSearchInput
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._search_career_levels_in_bulk_serialize(
+            career_level_search_input=career_level_search_input,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CareerLevelSearchOutput",
+            '400': "ApiError",
+            '500': "ApiError",
+            '504': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def search_career_levels_in_bulk_with_http_info(
+        self,
+        career_level_search_input: Annotated[CareerLevelSearchInput, Field(description="A list of requests that contain job IDs to look up. Returns career levels that match.  Include the mandatory `jobIDs` field. ")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[CareerLevelSearchOutput]:
+        """Get career level members in bulk
+
+        Retrieve career level members in bulk by job IDs. 
+
+        :param career_level_search_input: A list of requests that contain job IDs to look up. Returns career levels that match.  Include the mandatory `jobIDs` field.  (required)
+        :type career_level_search_input: CareerLevelSearchInput
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._search_career_levels_in_bulk_serialize(
+            career_level_search_input=career_level_search_input,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CareerLevelSearchOutput",
+            '400': "ApiError",
+            '500': "ApiError",
+            '504': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def search_career_levels_in_bulk_without_preload_content(
+        self,
+        career_level_search_input: Annotated[CareerLevelSearchInput, Field(description="A list of requests that contain job IDs to look up. Returns career levels that match.  Include the mandatory `jobIDs` field. ")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get career level members in bulk
+
+        Retrieve career level members in bulk by job IDs. 
+
+        :param career_level_search_input: A list of requests that contain job IDs to look up. Returns career levels that match.  Include the mandatory `jobIDs` field.  (required)
+        :type career_level_search_input: CareerLevelSearchInput
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._search_career_levels_in_bulk_serialize(
+            career_level_search_input=career_level_search_input,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CareerLevelSearchOutput",
+            '400': "ApiError",
+            '500': "ApiError",
+            '504': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _search_career_levels_in_bulk_serialize(
+        self,
+        career_level_search_input,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if career_level_search_input is not None:
+            _body_params = career_level_search_input
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'api_key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v1/compensation-benchmarks/career-levels/search',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call
     def search_jobs(
         self,