# 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
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from mixpeek.models.storage_provider import StorageProvider
from typing import Optional, Set
from typing_extensions import Self

class StorageConnectionCreateRequest(BaseModel):
    """
    Request payload for creating a new storage connection.  Use this to connect Mixpeek to external storage providers like Google Drive or S3. The connection will be tested before being saved (unless test_before_save is False).  **Use Cases:** - Connect to team Google Drive for automated file ingestion - Link customer S3 buckets for batch processing - Set up storage connections for sync operations  **Security:** - Credentials are encrypted at rest using MongoDB field-level encryption - Credentials never appear in API responses or logs - Connection is tested before saving to validate credentials  **Examples:** ```python # Google Drive connection {     \"name\": \"Marketing Drive\",     \"provider_type\": \"google_drive\",     \"provider_config\": {         \"credentials\": {...},         \"shared_drive_id\": \"0AH-Xabc123\"     },     \"description\": \"Team drive for marketing assets\" } ```
    """ # noqa: E501
    name: Annotated[str, Field(min_length=1, strict=True, max_length=100)] = Field(description="REQUIRED. Human-readable name for the storage connection. Must be unique within the organization. Displayed in dashboards and sync logs. Format: 1-100 characters, descriptive of the connection's purpose.")
    provider_type: StorageProvider = Field(description="REQUIRED. Storage provider to connect to. Supported providers: google_drive, s3, snowflake, sharepoint, tigris. Determines which authentication and sync logic is used.")
    provider_config: Dict[str, Any] = Field(description="REQUIRED. Provider-specific configuration including credentials. Structure varies by provider_type. SECURITY: Sensitive credential fields (private_key, secret_access_key, client_secret, refresh_token, session_token) are automatically encrypted at rest and never appear in responses or logs.")
    description: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="OPTIONAL. Description explaining the connection's purpose and scope. Helpful for team collaboration and documentation. Format: Up to 500 characters.")
    metadata: Optional[Dict[str, Any]] = Field(default=None, description="OPTIONAL. Arbitrary key-value metadata for tagging and categorization. Common uses: team tags, cost center codes, project identifiers.")
    test_before_save: Optional[StrictBool] = Field(default=True, description="OPTIONAL. Whether to validate credentials before saving the connection. Defaults to True. If True, connection will be tested against the provider before creation. If False, connection is saved without validation (use with caution).")
    __properties: ClassVar[List[str]] = ["name", "provider_type", "provider_config", "description", "metadata", "test_before_save"]

    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 StorageConnectionCreateRequest 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 StorageConnectionCreateRequest 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"),
            "provider_type": obj.get("provider_type"),
            "provider_config": obj.get("provider_config"),
            "description": obj.get("description"),
            "metadata": obj.get("metadata"),
            "test_before_save": obj.get("test_before_save") if obj.get("test_before_save") is not None else True
        })
        return _obj


