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

visier_platform_sdk/api/benchmarks_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.2145
     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
@@ -22,6 +21,7 @@ from typing import List, Optional
 from typing_extensions import Annotated
 from visier_platform_sdk.models.benchmark_info import BenchmarkInfo
 from visier_platform_sdk.models.benchmark_value import BenchmarkValue
+from visier_platform_sdk.models.salary_benchmark_feedback_input import SalaryBenchmarkFeedbackInput
 from visier_platform_sdk.models.salary_benchmark_input import SalaryBenchmarkInput
 from visier_platform_sdk.models.salary_benchmarks_batch_processing_outputs import SalaryBenchmarksBatchProcessingOutputs
 
@@ -96,8 +96,7 @@ class BenchmarksApi:
             '200': "List[BenchmarkInfo]",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -161,8 +160,7 @@ class BenchmarksApi:
             '200': "List[BenchmarkInfo]",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -226,8 +224,7 @@ class BenchmarksApi:
             '200': "List[BenchmarkInfo]",
             '500': "ApiError",
             '504': "ApiError",
-        }
-        response_data = self.api_client.call_api(
+        }        response_data = self.api_client.call_api(
             *_param,
             _request_timeout=_request_timeout
         )
@@ -304,6 +301,7 @@ class BenchmarksApi:
         location: Annotated[Optional[StrictStr], Field(description="The location member ID. If the ID is not provided, the response returns the benchmark value across all locations. ")] = None,
         company_size: Annotated[Optional[StrictStr], Field(description="The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes. ")] = None,
         career_level: Annotated[Optional[StrictStr], Field(description="The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. ")] = None,
+        match_date: Annotated[Optional[StrictStr], Field(description="The date on which the career level was matched in `yyyy-MM-dd` format. A `matchDate` allows precise migration of career levels according to job architecture changes released since the match was made. If `matchDate` is not available, the migration assumes the most recent possible match date for the provided career level. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -333,6 +331,8 @@ class BenchmarksApi:
         :type company_size: str
         :param career_level: The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. 
         :type career_level: str
+        :param match_date: The date on which the career level was matched in `yyyy-MM-dd` format. A `matchDate` allows precise migration of career levels according to job architecture changes released since the match was made. If `matchDate` is not available, the migration assumes the most recent possible match date for the provided career level. 
+        :type match_date: str
         :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
@@ -362,6 +362,7 @@ class BenchmarksApi:
             location=location,
             company_size=company_size,
             career_level=career_level,
+            match_date=match_date,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -373,8 +374,7 @@ class BenchmarksApi:
             '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
         )
@@ -394,6 +394,7 @@ class BenchmarksApi:
         location: Annotated[Optional[StrictStr], Field(description="The location member ID. If the ID is not provided, the response returns the benchmark value across all locations. ")] = None,
         company_size: Annotated[Optional[StrictStr], Field(description="The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes. ")] = None,
         career_level: Annotated[Optional[StrictStr], Field(description="The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. ")] = None,
+        match_date: Annotated[Optional[StrictStr], Field(description="The date on which the career level was matched in `yyyy-MM-dd` format. A `matchDate` allows precise migration of career levels according to job architecture changes released since the match was made. If `matchDate` is not available, the migration assumes the most recent possible match date for the provided career level. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -423,6 +424,8 @@ class BenchmarksApi:
         :type company_size: str
         :param career_level: The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. 
         :type career_level: str
+        :param match_date: The date on which the career level was matched in `yyyy-MM-dd` format. A `matchDate` allows precise migration of career levels according to job architecture changes released since the match was made. If `matchDate` is not available, the migration assumes the most recent possible match date for the provided career level. 
+        :type match_date: str
         :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
@@ -452,6 +455,7 @@ class BenchmarksApi:
             location=location,
             company_size=company_size,
             career_level=career_level,
+            match_date=match_date,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -463,8 +467,7 @@ class BenchmarksApi:
             '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
         )
@@ -484,6 +487,7 @@ class BenchmarksApi:
         location: Annotated[Optional[StrictStr], Field(description="The location member ID. If the ID is not provided, the response returns the benchmark value across all locations. ")] = None,
         company_size: Annotated[Optional[StrictStr], Field(description="The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes. ")] = None,
         career_level: Annotated[Optional[StrictStr], Field(description="The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. ")] = None,
+        match_date: Annotated[Optional[StrictStr], Field(description="The date on which the career level was matched in `yyyy-MM-dd` format. A `matchDate` allows precise migration of career levels according to job architecture changes released since the match was made. If `matchDate` is not available, the migration assumes the most recent possible match date for the provided career level. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -513,6 +517,8 @@ class BenchmarksApi:
         :type company_size: str
         :param career_level: The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels. 
         :type career_level: str
+        :param match_date: The date on which the career level was matched in `yyyy-MM-dd` format. A `matchDate` allows precise migration of career levels according to job architecture changes released since the match was made. If `matchDate` is not available, the migration assumes the most recent possible match date for the provided career level. 
+        :type match_date: str
         :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
@@ -542,6 +548,7 @@ class BenchmarksApi:
             location=location,
             company_size=company_size,
             career_level=career_level,
+            match_date=match_date,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -553,8 +560,7 @@ class BenchmarksApi:
             '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
         )
@@ -569,6 +575,7 @@ class BenchmarksApi:
         location,
         company_size,
         career_level,
+        match_date,
         _request_auth,
         _content_type,
         _headers,
@@ -615,6 +622,10 @@ class BenchmarksApi:
             
             _query_params.append(('careerLevel', career_level))
             
+        if match_date is not None:
+            
+            _query_params.append(('matchDate', match_date))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -710,8 +721,7 @@ class BenchmarksApi:
             '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
         )
@@ -780,8 +790,7 @@ class BenchmarksApi:
             '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
         )
@@ -850,8 +859,7 @@ class BenchmarksApi:
             '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
         )
@@ -934,3 +942,283 @@ class BenchmarksApi:
         )
 
 
+
+
+    @validate_call
+    def submit_salary_benchmark_feedback(
+        self,
+        salary_benchmark_feedback_input: Annotated[SalaryBenchmarkFeedbackInput, Field(description="The feedback to submit. ")],
+        _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,
+    ) -> None:
+        """Submit feedback to improve salary benchmark values
+
+        Give feedback for a salary benchmark value returned by `GET /v1/compensation-benchmarks/base-salary` or `/base-salaries`. To submit feedback, include the benchmark value's:   * ID values you defined in `GET /v1/compensation-benchmarks/base-salary` or `/base-salaries`.   * `referenceDate` and `releaseDate` returned by `GET /v1/compensation-benchmarks/base-salary` or `/base-salaries`.   * Optional `additionalComments` up to 150 characters. 
+
+        :param salary_benchmark_feedback_input: The feedback to submit.  (required)
+        :type salary_benchmark_feedback_input: SalaryBenchmarkFeedbackInput
+        :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._submit_salary_benchmark_feedback_serialize(
+            salary_benchmark_feedback_input=salary_benchmark_feedback_input,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+            '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 submit_salary_benchmark_feedback_with_http_info(
+        self,
+        salary_benchmark_feedback_input: Annotated[SalaryBenchmarkFeedbackInput, Field(description="The feedback to submit. ")],
+        _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[None]:
+        """Submit feedback to improve salary benchmark values
+
+        Give feedback for a salary benchmark value returned by `GET /v1/compensation-benchmarks/base-salary` or `/base-salaries`. To submit feedback, include the benchmark value's:   * ID values you defined in `GET /v1/compensation-benchmarks/base-salary` or `/base-salaries`.   * `referenceDate` and `releaseDate` returned by `GET /v1/compensation-benchmarks/base-salary` or `/base-salaries`.   * Optional `additionalComments` up to 150 characters. 
+
+        :param salary_benchmark_feedback_input: The feedback to submit.  (required)
+        :type salary_benchmark_feedback_input: SalaryBenchmarkFeedbackInput
+        :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._submit_salary_benchmark_feedback_serialize(
+            salary_benchmark_feedback_input=salary_benchmark_feedback_input,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+            '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 submit_salary_benchmark_feedback_without_preload_content(
+        self,
+        salary_benchmark_feedback_input: Annotated[SalaryBenchmarkFeedbackInput, Field(description="The feedback to submit. ")],
+        _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:
+        """Submit feedback to improve salary benchmark values
+
+        Give feedback for a salary benchmark value returned by `GET /v1/compensation-benchmarks/base-salary` or `/base-salaries`. To submit feedback, include the benchmark value's:   * ID values you defined in `GET /v1/compensation-benchmarks/base-salary` or `/base-salaries`.   * `referenceDate` and `releaseDate` returned by `GET /v1/compensation-benchmarks/base-salary` or `/base-salaries`.   * Optional `additionalComments` up to 150 characters. 
+
+        :param salary_benchmark_feedback_input: The feedback to submit.  (required)
+        :type salary_benchmark_feedback_input: SalaryBenchmarkFeedbackInput
+        :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._submit_salary_benchmark_feedback_serialize(
+            salary_benchmark_feedback_input=salary_benchmark_feedback_input,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+            '400': "ApiError",
+            '500': "ApiError",
+            '504': "ApiError",
+        }        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _submit_salary_benchmark_feedback_serialize(
+        self,
+        salary_benchmark_feedback_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 salary_benchmark_feedback_input is not None:
+            _body_params = salary_benchmark_feedback_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/base-salary/feedback',
+            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
+        )
+
+