openlark-docs 0.17.0

//! 删除文件或文件夹
//!
//! 删除用户在云空间内的文件或者文件夹。文件或者文件夹被删除后，会进入用户回收站里。
//!
//! docPath: https://open.feishu.cn/document/server-docs/docs/drive-v1/file/delete

use crate::common::{api_endpoints::DriveApi, api_utils::*};
use openlark_core::{
    SDKResult,
    api::{ApiRequest, ApiResponseTrait, ResponseFormat},
    config::Config,
    http::Transport,
    validate_required,
};
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize)]
/// 公开项说明。
pub struct DeleteFileRequest {
    #[serde(skip)]
    config: Config,
    /// 需要删除的文件或文件夹 token
    pub file_token: String,
    /// 被删除文件的类型
    #[serde(skip)]
    pub r#type: String,
}

impl DeleteFileRequest {
    /// 创建新的实例。
    pub fn new(config: Config, file_token: impl Into<String>, r#type: impl Into<String>) -> Self {
        Self {
            config,
            file_token: file_token.into(),
            r#type: r#type.into(),
        }
    }

    /// 执行请求。
    pub async fn execute(self) -> SDKResult<DeleteFileResponse> {
        self.execute_with_options(openlark_core::req_option::RequestOption::default())
            .await
    }

    /// 使用指定请求选项执行请求。
    pub async fn execute_with_options(
        self,
        option: openlark_core::req_option::RequestOption,
    ) -> SDKResult<DeleteFileResponse> {
        // 验证必填字段
        validate_required!(self.file_token.trim(), "file_token 不能为空");
        validate_required!(self.r#type.trim(), "type 不能为空");

        // 自定义验证逻辑：type 枚举值验证
        match self.r#type.as_str() {
            "file" | "docx" | "bitable" | "folder" | "doc" | "sheet" | "mindnote" | "shortcut"
            | "slides" => {}
            _ => {
                return Err(openlark_core::error::validation_error(
                    "type",
                    "type 仅支持 file/docx/bitable/folder/doc/sheet/mindnote/shortcut/slides",
                ));
            }
        }

        let api_endpoint = DriveApi::DeleteFile(self.file_token);
        let mut request = ApiRequest::<DeleteFileResponse>::delete(&api_endpoint.to_url());

        request = request.query("type", self.r#type);

        let response = Transport::request(request, &self.config, Some(option)).await?;
        extract_response_data(response, "删除文件或文件夹")
    }
}

/// 删除文件或文件夹响应（data）
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DeleteFileResponse {
    /// 异步任务 ID，删除文件夹时返回
    pub task_id: Option<String>,
}

impl ApiResponseTrait for DeleteFileResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_delete_file_request() {
        let config = Config::default();
        let request = DeleteFileRequest::new(config, "token_123", "file");
        assert_eq!(request.file_token, "token_123");
        assert_eq!(request.r#type, "file");
    }
}