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

visier_platform_sdk/models/salary_benchmarks_batch_processing_failure_output.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    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
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SalaryBenchmarksBatchProcessingFailureOutput(BaseModel):
+    """
+    Error description for individual requests within a bulk request. 
+    """ # noqa: E501
+    uuid: StrictStr = Field(description="A unique identifier of the individual requests. ")
+    http_status: StrictStr = Field(description="A three-digit code that indicates the outcome of a request. ", alias="httpStatus")
+    message: StrictStr = Field(description="The details of the error. ")
+    rci: StrictStr = Field(description="A root cause identifier that allows Visier to determine the source of the problem. ")
+    error_code: StrictStr = Field(description="A brief identifier of the type of error. ", alias="errorCode")
+    __properties: ClassVar[List[str]] = ["uuid", "httpStatus", "message", "rci", "errorCode"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SalaryBenchmarksBatchProcessingFailureOutput from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SalaryBenchmarksBatchProcessingFailureOutput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "uuid": obj.get("uuid"),
+            "httpStatus": obj.get("httpStatus"),
+            "message": obj.get("message"),
+            "rci": obj.get("rci"),
+            "errorCode": obj.get("errorCode")
+        })
+        return _obj
+
+

visier_platform_sdk/models/salary_benchmarks_batch_processing_outputs.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    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
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.salary_benchmarks_batch_processing_failure_output import SalaryBenchmarksBatchProcessingFailureOutput
+from visier_platform_sdk.models.salary_benchmarks_batch_processing_successful_output import SalaryBenchmarksBatchProcessingSuccessfulOutput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SalaryBenchmarksBatchProcessingOutputs(BaseModel):
+    """
+    All operations in the bulk request were completed. 
+    """ # noqa: E501
+    successes: Optional[List[SalaryBenchmarksBatchProcessingSuccessfulOutput]] = None
+    failures: Optional[List[SalaryBenchmarksBatchProcessingFailureOutput]] = None
+    __properties: ClassVar[List[str]] = ["successes", "failures"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SalaryBenchmarksBatchProcessingOutputs from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in successes (list)
+        _items = []
+        if self.successes:
+            for _item_successes in self.successes:
+                if _item_successes:
+                    _items.append(_item_successes.to_dict())
+            _dict['successes'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in failures (list)
+        _items = []
+        if self.failures:
+            for _item_failures in self.failures:
+                if _item_failures:
+                    _items.append(_item_failures.to_dict())
+            _dict['failures'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SalaryBenchmarksBatchProcessingOutputs from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "successes": [SalaryBenchmarksBatchProcessingSuccessfulOutput.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None,
+            "failures": [SalaryBenchmarksBatchProcessingFailureOutput.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/salary_benchmarks_batch_processing_successful_output.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    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
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SalaryBenchmarksBatchProcessingSuccessfulOutput(BaseModel):
+    """
+    The compensation benchmark values for individual requests within a bulk request. 
+    """ # noqa: E501
+    uuid: StrictStr = Field(description="A unique identifier of the individual requests. ")
+    percentile10: StrictInt = Field(description="The 10th percentile base pay. ")
+    percentile25: StrictInt = Field(description="The 25th percentile base pay. ")
+    percentile50: StrictInt = Field(description="The 50th percentile base pay. ")
+    percentile75: StrictInt = Field(description="The 75th percentile base pay. ")
+    percentile90: StrictInt = Field(description="The 90th percentile base pay. ")
+    aligned_range_min: StrictInt = Field(description="The lower bound of salaries that are aligned with the market. ", alias="alignedRangeMin")
+    aligned_range_max: StrictInt = Field(description="The upper bound of salaries that are aligned with the market. ", alias="alignedRangeMax")
+    reference_date: StrictStr = Field(description="The date that benchmark values are calculated for. ", alias="referenceDate")
+    release_date: StrictStr = Field(description="The date that benchmark values are released. ", alias="releaseDate")
+    industry_id: StrictStr = Field(description="The industry member ID for the returned benchmarks. ", alias="industryId")
+    career_level_id: StrictStr = Field(description="The career level member ID for the returned benchmarks. ", alias="careerLevelId")
+    __properties: ClassVar[List[str]] = ["uuid", "percentile10", "percentile25", "percentile50", "percentile75", "percentile90", "alignedRangeMin", "alignedRangeMax", "referenceDate", "releaseDate", "industryId", "careerLevelId"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SalaryBenchmarksBatchProcessingSuccessfulOutput from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SalaryBenchmarksBatchProcessingSuccessfulOutput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "uuid": obj.get("uuid"),
+            "percentile10": obj.get("percentile10"),
+            "percentile25": obj.get("percentile25"),
+            "percentile50": obj.get("percentile50"),
+            "percentile75": obj.get("percentile75"),
+            "percentile90": obj.get("percentile90"),
+            "alignedRangeMin": obj.get("alignedRangeMin"),
+            "alignedRangeMax": obj.get("alignedRangeMax"),
+            "referenceDate": obj.get("referenceDate"),
+            "releaseDate": obj.get("releaseDate"),
+            "industryId": obj.get("industryId"),
+            "careerLevelId": obj.get("careerLevelId")
+        })
+        return _obj
+
+

visier_platform_sdk/models/salesforce_auth_params_dto.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    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
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SalesforceAuthParamsDTO(BaseModel):
+    """
+    SalesforceAuthParamsDTO
+    """ # noqa: E501
+    refresh_token: Optional[StrictStr] = Field(default=None, alias="refreshToken")
+    client_id: Optional[StrictStr] = Field(default=None, alias="clientId")
+    __properties: ClassVar[List[str]] = ["refreshToken", "clientId"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SalesforceAuthParamsDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SalesforceAuthParamsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "refreshToken": obj.get("refreshToken"),
+            "clientId": obj.get("clientId")
+        })
+        return _obj
+
+

visier_platform_sdk/models/salesforce_v2_auth_params_dto.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    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
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SalesforceV2AuthParamsDTO(BaseModel):
+    """
+    SalesforceV2AuthParamsDTO
+    """ # noqa: E501
+    auth_code: Optional[StrictStr] = Field(default=None, alias="authCode")
+    client_id: Optional[StrictStr] = Field(default=None, alias="clientId")
+    client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret")
+    login_host: Optional[StrictStr] = Field(default=None, alias="loginHost")
+    __properties: ClassVar[List[str]] = ["authCode", "clientId", "clientSecret", "loginHost"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SalesforceV2AuthParamsDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SalesforceV2AuthParamsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "authCode": obj.get("authCode"),
+            "clientId": obj.get("clientId"),
+            "clientSecret": obj.get("clientSecret"),
+            "loginHost": obj.get("loginHost")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sample_question_api_response_dto.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    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
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.user_group_assignment_dto import UserGroupAssignmentDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SampleQuestionAPIResponseDTO(BaseModel):
+    """
+    SampleQuestionAPIResponseDTO
+    """ # noqa: E501
+    question: Optional[StrictStr] = Field(default=None, description="A question in plain language.")
+    question_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the sample question.", alias="questionId")
+    visible_in_vee: Optional[StrictBool] = Field(default=None, description="If `true`, the sample question is visible in Vee.", alias="visibleInVee")
+    category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the question category.", alias="categoryId")
+    user_group_assignment: Optional[UserGroupAssignmentDTO] = Field(default=None, description="The user group IDs assigned to the sample question.", alias="userGroupAssignment")
+    __properties: ClassVar[List[str]] = ["question", "questionId", "visibleInVee", "categoryId", "userGroupAssignment"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SampleQuestionAPIResponseDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of user_group_assignment
+        if self.user_group_assignment:
+            _dict['userGroupAssignment'] = self.user_group_assignment.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SampleQuestionAPIResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "question": obj.get("question"),
+            "questionId": obj.get("questionId"),
+            "visibleInVee": obj.get("visibleInVee"),
+            "categoryId": obj.get("categoryId"),
+            "userGroupAssignment": UserGroupAssignmentDTO.from_dict(obj["userGroupAssignment"]) if obj.get("userGroupAssignment") is not None else None
+        })
+        return _obj
+
+