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

visier_platform_sdk/models/dimension_mapping_validation_execution_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 DimensionMappingValidationExecutionDTO(BaseModel):
+    """
+    Instruction to execute a mapping validation query
+    """ # noqa: E501
+    member_map_id: Optional[StrictStr] = Field(default=None, description="memberMapId == dimensionMapId", alias="memberMapId")
+    analytic_object: Optional[StrictStr] = Field(default=None, description="The analytic object associated with the dimension map.", alias="analyticObject")
+    __properties: ClassVar[List[str]] = ["memberMapId", "analyticObject"]
+
+    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 DimensionMappingValidationExecutionDTO 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 DimensionMappingValidationExecutionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "memberMapId": obj.get("memberMapId"),
+            "analyticObject": obj.get("analyticObject")
+        })
+        return _obj
+
+

visier_platform_sdk/models/dimension_member.py

@@ -0,0 +1,139 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.description_entry import DescriptionEntry
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DimensionMember(BaseModel):
+    """
+    An element of a dimension that can be organized hierarchically. 
+    """ # noqa: E501
+    id: StrictStr = Field(description="Unique identifier of the member.")
+    name: StrictStr = Field(description="Name of the member.")
+    description: StrictStr = Field(description="Description of the member.")
+    has_benchmark_value: StrictBool = Field(description="True if this member has available benchmark values. False if this member has no available benchmark values. ", alias="hasBenchmarkValue")
+    has_children: StrictBool = Field(description="True if this member has children. False if this member has no children. For example, a leaf member. ", alias="hasChildren")
+    status: StrictStr = Field(description="Status of the member. If status is `archived`, the dimension member does not have a benchmark value.")
+    display_id: Optional[StrictStr] = Field(default=None, description="A user-friendly identifier of the member. This field will be excluded from the response if there is no displayId for the member.", alias="displayId")
+    short_description_sections: Optional[List[DescriptionEntry]] = Field(default=None, description="A short description of the member in structured format.", alias="shortDescriptionSections")
+    job_domain: Optional[StrictStr] = Field(default=None, description="Domain of a job member. This field will be excluded from the response if there is no domain for the member.", alias="jobDomain")
+    job_subdomain: Optional[StrictStr] = Field(default=None, description="Subdomain of a job member. This field will be excluded from the response if there is no subdomain for the member.", alias="jobSubdomain")
+    typical_titles: Optional[List[StrictStr]] = Field(default=None, description="Similar job titles for a job member. This field will be excluded from the response if there are no similar job titles.", alias="typicalTitles")
+    related_jobs: Optional[List[StrictStr]] = Field(default=None, description="The job IDs for similar jobs, sorted in descending order of similarity. This field will be excluded from the response if there are no similar jobs.", alias="relatedJobs")
+    naics_id: Optional[StrictStr] = Field(default=None, description="The North American Industry Classification System (NAICS) code that matches the provided naicsCode, using NAICS version 2022.", alias="naicsId")
+    naics_name: Optional[StrictStr] = Field(default=None, description="The name of the North American Industry Classification System (NAICS) category that matches the provided naicsCode, using NAICS version 2022.", alias="naicsName")
+    naics_description: Optional[StrictStr] = Field(default=None, description="The description of the North American Industry Classification System (NAICS) category that matches the provided naicsCode, using NAICS version 2022.", alias="naicsDescription")
+    soc_code: Optional[StrictStr] = Field(default=None, description="The Standard Occupational Classification (SOC) code for the job member, using SOC version 2018. This optional field is returned if a single SOC code maps to the job member.", alias="socCode")
+    soc_name: Optional[StrictStr] = Field(default=None, description="The detailed occupation name from the Standard Occupational Classification (SOC) system for the job member, using SOC version 2018. This optional field is returned if a single SOC code maps to the job member.", alias="socName")
+    soc_codes: Optional[Dict[str, Any]] = Field(default=None, description="The Standard Occupational Classification (SOC) codes for the job member mapped to career level ids, using SOC version 2018. This optional field is returned if multiple SOC codes map to different career levels of the job member.", alias="socCodes")
+    soc_names: Optional[Dict[str, Any]] = Field(default=None, description="The detailed occupation names from the Standard Occupational Classification (SOC) system for the job member mapped to career level ids, using SOC version 2018. This optional field is returned if multiple SOC codes map to different career levels of the job member.", alias="socNames")
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "hasBenchmarkValue", "hasChildren", "status", "displayId", "shortDescriptionSections", "jobDomain", "jobSubdomain", "typicalTitles", "relatedJobs", "naicsId", "naicsName", "naicsDescription", "socCode", "socName", "socCodes", "socNames"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['active', 'archived']):
+            raise ValueError("must be one of enum values ('active', 'archived')")
+        return value
+
+    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 DimensionMember 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 short_description_sections (list)
+        _items = []
+        if self.short_description_sections:
+            for _item_short_description_sections in self.short_description_sections:
+                if _item_short_description_sections:
+                    _items.append(_item_short_description_sections.to_dict())
+            _dict['shortDescriptionSections'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DimensionMember from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "hasBenchmarkValue": obj.get("hasBenchmarkValue"),
+            "hasChildren": obj.get("hasChildren"),
+            "status": obj.get("status"),
+            "displayId": obj.get("displayId"),
+            "shortDescriptionSections": [DescriptionEntry.from_dict(_item) for _item in obj["shortDescriptionSections"]] if obj.get("shortDescriptionSections") is not None else None,
+            "jobDomain": obj.get("jobDomain"),
+            "jobSubdomain": obj.get("jobSubdomain"),
+            "typicalTitles": obj.get("typicalTitles"),
+            "relatedJobs": obj.get("relatedJobs"),
+            "naicsId": obj.get("naicsId"),
+            "naicsName": obj.get("naicsName"),
+            "naicsDescription": obj.get("naicsDescription"),
+            "socCode": obj.get("socCode"),
+            "socName": obj.get("socName"),
+            "socCodes": obj.get("socCodes"),
+            "socNames": obj.get("socNames")
+        })
+        return _obj
+
+

visier_platform_sdk/models/dimension_member_dto.py

@@ -0,0 +1,88 @@
+# 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 DimensionMemberDTO(BaseModel):
+    """
+    DimensionMemberDTO
+    """ # noqa: E501
+    dimension_member: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing the dimension members. Dimension members in a hierarchical dimension  will have an array with multiple strings.", alias="dimensionMember")
+    __properties: ClassVar[List[str]] = ["dimensionMember"]
+
+    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 DimensionMemberDTO 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 DimensionMemberDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dimensionMember": obj.get("dimensionMember")
+        })
+        return _obj
+
+

visier_platform_sdk/models/dimension_member_reference_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 DimensionMemberReferenceDTO(BaseModel):
+    """
+    The members of a dimension.
+    """ # noqa: E501
+    path: Optional[List[StrictStr]] = Field(default=None, description="A list of strings representing the members within a dimension path. For example, a dimension for Location  may have the paths \"Canada, BC, Vancouver\" and \"US, California, San Francisco\".")
+    member_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dimension member. Use `memberId` if the dimension member doesn't have a path, such as SD groups.", alias="memberId")
+    __properties: ClassVar[List[str]] = ["path", "memberId"]
+
+    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 DimensionMemberReferenceDTO 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 DimensionMemberReferenceDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "path": obj.get("path"),
+            "memberId": obj.get("memberId")
+        })
+        return _obj
+
+

visier_platform_sdk/models/dimension_reference_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 DimensionReferenceDTO(BaseModel):
+    """
+    The name and qualifying path of a dimension to query.
+    """ # noqa: E501
+    name: Optional[StrictStr] = Field(default=None, description="The ID of the dimension. To get a dimension's ID, call the Data Model API.")
+    qualifying_path: Optional[StrictStr] = Field(default=None, description="The qualifying path to the dimension in Visier, such as the analytic object or event the dimension is  associated with. If the path has multiple objects, each object is separated by a period.", alias="qualifyingPath")
+    __properties: ClassVar[List[str]] = ["name", "qualifyingPath"]
+
+    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 DimensionReferenceDTO 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 DimensionReferenceDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "qualifyingPath": obj.get("qualifyingPath")
+        })
+        return _obj
+
+

visier_platform_sdk/models/dimension_request_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
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.dimension_with_context_dto import DimensionWithContextDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DimensionRequestDTO(BaseModel):
+    """
+    The dimensions in the API request.
+    """ # noqa: E501
+    dimensions: Optional[List[DimensionWithContextDTO]] = Field(default=None, description="The dimensions in the request.")
+    __properties: ClassVar[List[str]] = ["dimensions"]
+
+    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 DimensionRequestDTO 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 dimensions (list)
+        _items = []
+        if self.dimensions:
+            for _item_dimensions in self.dimensions:
+                if _item_dimensions:
+                    _items.append(_item_dimensions.to_dict())
+            _dict['dimensions'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DimensionRequestDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dimensions": [DimensionWithContextDTO.from_dict(_item) for _item in obj["dimensions"]] if obj.get("dimensions") is not None else None
+        })
+        return _obj
+
+