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

visier_platform_sdk/models/basic_information_dto.py

@@ -0,0 +1,102 @@
+# 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 visier_platform_sdk.models.synonym_list_dto import SynonymListDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BasicInformationDTO(BaseModel):
+    """
+    Fields that identify and describe the object, such as its display name, description, and explanation.
+    """ # noqa: E501
+    display_name: Optional[StrictStr] = Field(default=None, description="The user-friendly name for the object.", alias="displayName")
+    short_display_name: Optional[StrictStr] = Field(default=None, description="A shortened version of the display name. If the object is visible in the solution experience, this name is displayed in visualization titles.", alias="shortDisplayName")
+    description: Optional[StrictStr] = Field(default=None, description="A short description of the object. Descriptions provide in-context help for your users while working in Visier.")
+    explanation: Optional[StrictStr] = Field(default=None, description="A longer description of the object that typically includes a definition, calculation details, and other guidance about how to use the object.")
+    designer_notes: Optional[StrictStr] = Field(default=None, description="An admin-only description of the object that provides design-specific information or considerations.", alias="designerNotes")
+    synonym_list: Optional[SynonymListDTO] = Field(default=None, description="Alternative words or phrases for the object.", alias="synonymList")
+    __properties: ClassVar[List[str]] = ["displayName", "shortDisplayName", "description", "explanation", "designerNotes", "synonymList"]
+
+    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 BasicInformationDTO 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 synonym_list
+        if self.synonym_list:
+            _dict['synonymList'] = self.synonym_list.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BasicInformationDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "displayName": obj.get("displayName"),
+            "shortDisplayName": obj.get("shortDisplayName"),
+            "description": obj.get("description"),
+            "explanation": obj.get("explanation"),
+            "designerNotes": obj.get("designerNotes"),
+            "synonymList": SynonymListDTO.from_dict(obj["synonymList"]) if obj.get("synonymList") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/basic_s3_auth_params_dto.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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BasicS3AuthParamsDTO(BaseModel):
+    """
+    BasicS3AuthParamsDTO
+    """ # noqa: E501
+    bucket_name: Optional[StrictStr] = Field(default=None, alias="bucketName")
+    bucket_region: Optional[StrictStr] = Field(default=None, alias="bucketRegion")
+    access_key: Optional[StrictStr] = Field(default=None, alias="accessKey")
+    secret_key: Optional[StrictStr] = Field(default=None, alias="secretKey")
+    path: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["bucketName", "bucketRegion", "accessKey", "secretKey", "path"]
+
+    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 BasicS3AuthParamsDTO 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 BasicS3AuthParamsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "bucketName": obj.get("bucketName"),
+            "bucketRegion": obj.get("bucketRegion"),
+            "accessKey": obj.get("accessKey"),
+            "secretKey": obj.get("secretKey"),
+            "path": obj.get("path")
+        })
+        return _obj
+
+

visier_platform_sdk/models/batch_tenant_provision_apidto.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
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.tenant_provision_apidto import TenantProvisionAPIDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BatchTenantProvisionAPIDTO(BaseModel):
+    """
+    BatchTenantProvisionAPIDTO
+    """ # noqa: E501
+    tenants: Optional[List[TenantProvisionAPIDTO]] = Field(default=None, description="An array of tenants to create. The maximum number of tenants to create in one request is 200.")
+    __properties: ClassVar[List[str]] = ["tenants"]
+
+    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 BatchTenantProvisionAPIDTO 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 tenants (list)
+        _items = []
+        if self.tenants:
+            for _item_tenants in self.tenants:
+                if _item_tenants:
+                    _items.append(_item_tenants.to_dict())
+            _dict['tenants'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BatchTenantProvisionAPIDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tenants": [TenantProvisionAPIDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/benchmark_info.py

@@ -0,0 +1,92 @@
+# 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 BenchmarkInfo(BaseModel):
+    """
+    Metadata that summarizes the benchmark dataset and API such as the release date. 
+    """ # noqa: E501
+    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")
+    api_release_date: StrictStr = Field(description="The date that API changes are released. ", alias="apiReleaseDate")
+    __properties: ClassVar[List[str]] = ["referenceDate", "releaseDate", "apiReleaseDate"]
+
+    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 BenchmarkInfo 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 BenchmarkInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "referenceDate": obj.get("referenceDate"),
+            "releaseDate": obj.get("releaseDate"),
+            "apiReleaseDate": obj.get("apiReleaseDate")
+        })
+        return _obj
+
+

visier_platform_sdk/models/benchmark_value.py

@@ -0,0 +1,108 @@
+# 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 BenchmarkValue(BaseModel):
+    """
+    The compensation benchmark value. 
+    """ # noqa: E501
+    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]] = ["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 BenchmarkValue 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 BenchmarkValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "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/big_query_auth_params_dto.py

@@ -0,0 +1,104 @@
+# 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 visier_platform_sdk.models.big_query_service_account_params_dto import BigQueryServiceAccountParamsDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BigQueryAuthParamsDTO(BaseModel):
+    """
+    BigQueryAuthParamsDTO
+    """ # noqa: E501
+    project_id: Optional[StrictStr] = Field(default=None, alias="projectId")
+    dataset_location: Optional[StrictStr] = Field(default=None, alias="datasetLocation")
+    refresh_token: Optional[StrictStr] = Field(default=None, alias="refreshToken")
+    client_id: Optional[StrictStr] = Field(default=None, alias="clientId")
+    client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret")
+    default_dataset: Optional[StrictStr] = Field(default=None, alias="defaultDataset")
+    service_account_params: Optional[BigQueryServiceAccountParamsDTO] = Field(default=None, alias="serviceAccountParams")
+    __properties: ClassVar[List[str]] = ["projectId", "datasetLocation", "refreshToken", "clientId", "clientSecret", "defaultDataset", "serviceAccountParams"]
+
+    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 BigQueryAuthParamsDTO 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 service_account_params
+        if self.service_account_params:
+            _dict['serviceAccountParams'] = self.service_account_params.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BigQueryAuthParamsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "projectId": obj.get("projectId"),
+            "datasetLocation": obj.get("datasetLocation"),
+            "refreshToken": obj.get("refreshToken"),
+            "clientId": obj.get("clientId"),
+            "clientSecret": obj.get("clientSecret"),
+            "defaultDataset": obj.get("defaultDataset"),
+            "serviceAccountParams": BigQueryServiceAccountParamsDTO.from_dict(obj["serviceAccountParams"]) if obj.get("serviceAccountParams") is not None else None
+        })
+        return _obj
+
+