# coding: utf-8

"""
    Mixpeek API

    This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.

    The version of the OpenAPI document: 1.3.0
    Contact: info@mixpeek.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, StrictInt, StrictStr, field_validator
from typing import Any, ClassVar, Dict, List, Optional
from typing import Optional, Set
from typing_extensions import Self

class FolderPathSource(BaseModel):
    """
    Extract value from the folder path structure.  Useful for deriving categories or metadata from folder organization. Can extract the full path, a specific segment, or the immediate parent.  Provider Compatibility: All providers with folder/prefix structure  Example folder structure: /Marketing/Campaigns/Q4-2024/videos/     - segment=0 -> \"Marketing\"     - segment=1 -> \"Campaigns\"     - segment=2 -> \"Q4-2024\"     - segment=-1 -> \"videos\" (last segment)     - full_path=True -> \"Marketing/Campaigns/Q4-2024/videos\"     - Neither (default) -> \"videos\" (immediate parent)  Use Cases:     - Derive category from top-level folder     - Extract project name from folder structure     - Preserve full path for hierarchical organization  Attributes:     type: Must be \"folder_path\" to identify this source type     segment: Index of path segment to extract (0-based, negative for reverse)     full_path: Whether to extract complete path
    """ # noqa: E501
    type: Optional[StrictStr] = Field(default='folder_path', description="Source type identifier. Must be 'folder_path' for path extraction.")
    segment: Optional[StrictInt] = Field(default=None, description="Extract a specific path segment by index. 0 = first segment (root folder), 1 = second segment, etc. -1 = last segment (immediate parent), -2 = second to last, etc. If None and full_path is False, extracts the immediate parent folder.")
    full_path: Optional[StrictBool] = Field(default=False, description="If True, extracts the complete folder path (joined with '/'). If False, extracts only the segment specified or immediate parent. Does not include the filename.")
    __properties: ClassVar[List[str]] = ["type", "segment", "full_path"]

    @field_validator('type')
    def type_validate_enum(cls, value):
        """Validates the enum"""
        if value is None:
            return value

        if value not in set(['folder_path']):
            raise ValueError("must be one of enum values ('folder_path')")
        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 FolderPathSource 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 FolderPathSource from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate({
            "type": obj.get("type") if obj.get("type") is not None else 'folder_path',
            "segment": obj.get("segment"),
            "full_path": obj.get("full_path") if obj.get("full_path") is not None else False
        })
        return _obj


