visier-platform-sdk 22222222.99201.2050__py3-none-any.whl → 22222222.99201.2165__py3-none-any.whl

visier_platform_sdk/api/dimensions_api.py

@@ -5,13 +5,12 @@
 
     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.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """  # noqa: E501
-
 import warnings
 from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
@@ -20,6 +19,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 +54,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 +76,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 +103,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,
@@ -110,8 +115,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -127,6 +131,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 +153,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 +180,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,
@@ -184,8 +192,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -201,6 +208,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 +230,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 +257,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,
@@ -258,8 +269,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -270,6 +280,7 @@ class DimensionsApi:
         self,
         job,
         has_benchmark_value,
+        include_archived,
         _request_auth,
         _content_type,
         _headers,
@@ -300,6 +311,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 +357,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 +379,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 +406,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,
@@ -399,8 +418,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -416,6 +434,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 +456,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 +483,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,
@@ -473,8 +495,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -490,6 +511,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 +533,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 +560,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,
@@ -547,8 +572,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -559,6 +583,7 @@ class DimensionsApi:
         self,
         headcount,
         has_benchmark_value,
+        include_archived,
         _request_auth,
         _content_type,
         _headers,
@@ -589,6 +614,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
@@ -633,6 +662,7 @@ class DimensionsApi:
         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)],
@@ -658,6 +688,8 @@ class DimensionsApi:
         :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
@@ -685,6 +717,7 @@ class DimensionsApi:
             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,
@@ -696,8 +729,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -715,6 +747,7 @@ class DimensionsApi:
         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)],
@@ -740,6 +773,8 @@ class DimensionsApi:
         :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
@@ -767,6 +802,7 @@ class DimensionsApi:
             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,
@@ -778,8 +814,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -797,6 +832,7 @@ class DimensionsApi:
         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)],
@@ -822,6 +858,8 @@ class DimensionsApi:
         :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
@@ -849,6 +887,7 @@ class DimensionsApi:
             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,8 +899,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -874,6 +912,7 @@ class DimensionsApi:
         naics_code,
         show_hierarchy,
         has_benchmark_value,
+        include_archived,
         _request_auth,
         _content_type,
         _headers,
@@ -912,6 +951,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
@@ -1007,8 +1050,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -1077,8 +1119,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -1147,8 +1188,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -1233,6 +1273,7 @@ class DimensionsApi:
         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)],
@@ -1268,6 +1309,8 @@ class DimensionsApi:
         :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
@@ -1300,6 +1343,7 @@ class DimensionsApi:
             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,
@@ -1311,8 +1355,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -1335,6 +1378,7 @@ class DimensionsApi:
         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)],
@@ -1370,6 +1414,8 @@ class DimensionsApi:
         :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
@@ -1402,6 +1448,7 @@ class DimensionsApi:
             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,
@@ -1413,8 +1460,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -1437,6 +1483,7 @@ class DimensionsApi:
         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)],
@@ -1472,6 +1519,8 @@ class DimensionsApi:
         :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
@@ -1504,6 +1553,7 @@ class DimensionsApi:
             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,
@@ -1515,8 +1565,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -1534,6 +1583,7 @@ class DimensionsApi:
         lexical_only,
         typical_titles_search,
         show_hierarchy,
+        include_archived,
         _request_auth,
         _content_type,
         _headers,
@@ -1592,6 +1642,10 @@ class DimensionsApi:
             
             _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
@@ -1637,6 +1691,7 @@ class DimensionsApi:
         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)],
@@ -1664,6 +1719,8 @@ class DimensionsApi:
         :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
@@ -1692,6 +1749,7 @@ class DimensionsApi:
             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,
@@ -1703,8 +1761,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -1723,6 +1780,7 @@ class DimensionsApi:
         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)],
@@ -1750,6 +1808,8 @@ class DimensionsApi:
         :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
@@ -1778,6 +1838,7 @@ class DimensionsApi:
             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,
@@ -1789,8 +1850,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -1809,6 +1869,7 @@ class DimensionsApi:
         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)],
@@ -1836,6 +1897,8 @@ class DimensionsApi:
         :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
@@ -1864,6 +1927,7 @@ class DimensionsApi:
             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,
@@ -1875,8 +1939,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -1890,6 +1953,7 @@ class DimensionsApi:
         postal_code,
         show_hierarchy,
         has_benchmark_value,
+        include_archived,
         _request_auth,
         _content_type,
         _headers,
@@ -1932,6 +1996,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
@@ -1969,6 +2037,286 @@ 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,
@@ -2027,8 +2375,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -2097,8 +2444,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -2167,8 +2513,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -2310,8 +2655,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -2380,8 +2724,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -2450,8 +2793,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -2593,8 +2935,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -2663,8 +3004,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -2733,8 +3073,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -2876,8 +3215,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -2946,8 +3284,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -3016,8 +3353,7 @@ class DimensionsApi:
             '400': "ApiError",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )