visier-platform-sdk 22222222.99201.1892b3__py3-none-any.whl

visier_platform_sdk/models/analysis_common_vee_status_code_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.99201.1892
+    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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AnalysisCommonVeeStatusCodeDTO(BaseModel):
+    """
+    AnalysisCommonVeeStatusCodeDTO
+    """ # noqa: E501
+    status_code: Optional[StrictStr] = Field(default=None, description="A status code indicating whether or not Vee successfully answered the question.", alias="statusCode")
+    status_msg: Optional[StrictStr] = Field(default=None, description="Additional information about whether or not Vee successfully answered the question.", alias="statusMsg")
+    __properties: ClassVar[List[str]] = ["statusCode", "statusMsg"]
+
+    @field_validator('status_code')
+    def status_code_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['UNDEFINED', 'VEE_API_SUCCESS', 'VEE_API_WARNING', 'VEE_API_ERROR']):
+            raise ValueError("must be one of enum values ('UNDEFINED', 'VEE_API_SUCCESS', 'VEE_API_WARNING', 'VEE_API_ERROR')")
+        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 AnalysisCommonVeeStatusCodeDTO 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 AnalysisCommonVeeStatusCodeDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "statusCode": obj.get("statusCode"),
+            "statusMsg": obj.get("statusMsg")
+        })
+        return _obj
+
+

visier_platform_sdk/models/analysis_common_vee_visual_dto.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.99201.1892
+    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 AnalysisCommonVeeVisualDTO(BaseModel):
+    """
+    AnalysisCommonVeeVisualDTO
+    """ # noqa: E501
+    image: Optional[StrictStr] = Field(default=None, description="A PNG visualization encoded in a base64 string.")
+    title: Optional[StrictStr] = Field(default=None, description="The visualization title.")
+    context: Optional[StrictStr] = Field(default=None, description="Any filters applied to the visualization. For example, a time filter of April 2024.")
+    __properties: ClassVar[List[str]] = ["image", "title", "context"]
+
+    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 AnalysisCommonVeeVisualDTO 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 AnalysisCommonVeeVisualDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "image": obj.get("image"),
+            "title": obj.get("title"),
+            "context": obj.get("context")
+        })
+        return _obj
+
+

visier_platform_sdk/models/analysis_common_vee_visual_options_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.99201.1892
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AnalysisCommonVeeVisualOptionsDTO(BaseModel):
+    """
+    AnalysisCommonVeeVisualOptionsDTO
+    """ # noqa: E501
+    width: Optional[StrictInt] = Field(default=None, description="The pixel width of the rendered visualization. Default is 600. Valid values are between 160 and 1600.")
+    height: Optional[StrictInt] = Field(default=None, description="The pixel height of the rendered visualization. Default is 338. Valid values are between 90 and 900.")
+    __properties: ClassVar[List[str]] = ["width", "height"]
+
+    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 AnalysisCommonVeeVisualOptionsDTO 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 AnalysisCommonVeeVisualOptionsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "width": obj.get("width"),
+            "height": obj.get("height")
+        })
+        return _obj
+
+

visier_platform_sdk/models/api_error.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.99201.1892
+    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 ApiError(BaseModel):
+    """
+    Description of an API error. 
+    """ # noqa: E501
+    error_code: StrictStr = Field(description="A brief identifier of the type of error. ", alias="errorCode")
+    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. ")
+    __properties: ClassVar[List[str]] = ["errorCode", "message", "rci"]
+
+    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 ApiError 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 ApiError from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "errorCode": obj.get("errorCode"),
+            "message": obj.get("message"),
+            "rci": obj.get("rci")
+        })
+        return _obj
+
+

visier_platform_sdk/models/authentication_o_auth2_user_info_dto.py

@@ -0,0 +1,117 @@
+# 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.99201.1892
+    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.authentication_o_auth2_user_subnet_info_dto import AuthenticationOAuth2UserSubnetInfoDTO
+from visier_platform_sdk.models.authentication_o_auth2_user_tenant_details_dto import AuthenticationOAuth2UserTenantDetailsDTO
+from visier_platform_sdk.models.servicing_servicing_capability_proto_enum_access_lookup_dto import ServicingServicingCapabilityProtoEnumAccessLookupDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AuthenticationOAuth2UserInfoDTO(BaseModel):
+    """
+    Response from OAuth 2 `userinfo` endpoint.
+    """ # noqa: E501
+    subject: Optional[StrictStr] = Field(default=None, description="The user's display name.")
+    name: Optional[StrictStr] = Field(default=None, description="The user's Common Name.")
+    email: Optional[StrictStr] = Field(default=None, description="The user's email address.")
+    visier_user_id: Optional[StrictStr] = Field(default=None, description="The user's unique ID.", alias="visier:user_id")
+    visier_capabilities: Optional[ServicingServicingCapabilityProtoEnumAccessLookupDTO] = Field(default=None, description="The user's profile capabilities.", alias="visier:capabilities")
+    visier_subnets: Optional[AuthenticationOAuth2UserSubnetInfoDTO] = Field(default=None, description="Subnet restrictions controlling the IP addresses from which users can access the tenant.", alias="visier:subnets")
+    visier_export_subnets: Optional[AuthenticationOAuth2UserSubnetInfoDTO] = Field(default=None, description="Subnet restrictions controlling the IP addresses from which data and metadata requests can be made.", alias="visier:export_subnets")
+    visier_tenant_details: Optional[AuthenticationOAuth2UserTenantDetailsDTO] = Field(default=None, description="Detailed information about the analytic tenant. Included in the response if `includeTenantDetail` is `true`.", alias="visier:tenant_details")
+    __properties: ClassVar[List[str]] = ["subject", "name", "email", "visier:user_id", "visier:capabilities", "visier:subnets", "visier:export_subnets", "visier:tenant_details"]
+
+    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 AuthenticationOAuth2UserInfoDTO 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 visier_capabilities
+        if self.visier_capabilities:
+            _dict['visier:capabilities'] = self.visier_capabilities.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of visier_subnets
+        if self.visier_subnets:
+            _dict['visier:subnets'] = self.visier_subnets.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of visier_export_subnets
+        if self.visier_export_subnets:
+            _dict['visier:export_subnets'] = self.visier_export_subnets.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of visier_tenant_details
+        if self.visier_tenant_details:
+            _dict['visier:tenant_details'] = self.visier_tenant_details.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AuthenticationOAuth2UserInfoDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "subject": obj.get("subject"),
+            "name": obj.get("name"),
+            "email": obj.get("email"),
+            "visier:user_id": obj.get("visier:user_id"),
+            "visier:capabilities": ServicingServicingCapabilityProtoEnumAccessLookupDTO.from_dict(obj["visier:capabilities"]) if obj.get("visier:capabilities") is not None else None,
+            "visier:subnets": AuthenticationOAuth2UserSubnetInfoDTO.from_dict(obj["visier:subnets"]) if obj.get("visier:subnets") is not None else None,
+            "visier:export_subnets": AuthenticationOAuth2UserSubnetInfoDTO.from_dict(obj["visier:export_subnets"]) if obj.get("visier:export_subnets") is not None else None,
+            "visier:tenant_details": AuthenticationOAuth2UserTenantDetailsDTO.from_dict(obj["visier:tenant_details"]) if obj.get("visier:tenant_details") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/authentication_o_auth2_user_subnet_info_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.99201.1892
+    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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AuthenticationOAuth2UserSubnetInfoDTO(BaseModel):
+    """
+    Subnet access details.
+    """ # noqa: E501
+    access_type: Optional[StrictStr] = Field(default=None, description="The type of subnet access granted to the user. Possible values are:  * `Unknown`: Could not determine subnet access details.  * `All`: No subnet restrictions.  * `Restricted`: Access is only granted to requests originating from the specified `subnets`.  * `None`: Access is denied. Only applicable to the Data Export API.", alias="accessType")
+    subnets: Optional[List[StrictStr]] = Field(default=None, description="The list of trusted IP addresses from which access is granted if accessType is `Restricted`. Must be in Classless Inter-Domain Routing (CIDR) format: `xxx.xxx.xxx.xxx/xx`.")
+    __properties: ClassVar[List[str]] = ["accessType", "subnets"]
+
+    @field_validator('access_type')
+    def access_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Unknown', 'All', 'Restricted', 'None']):
+            raise ValueError("must be one of enum values ('Unknown', 'All', 'Restricted', 'None')")
+        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 AuthenticationOAuth2UserSubnetInfoDTO 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 AuthenticationOAuth2UserSubnetInfoDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accessType": obj.get("accessType"),
+            "subnets": obj.get("subnets")
+        })
+        return _obj
+
+