openlark-docs 0.16.0

//! 获取词典分类
//!
//! docPath: https://open.feishu.cn/document/lingo-v1/classification/list

use openlark_core::{
    SDKResult,
    api::{ApiRequest, ApiResponseTrait, Response, ResponseFormat},
    config::Config,
    http::Transport,
    req_option::RequestOption,
};
use serde::{Deserialize, Serialize};

use crate::baike::lingo::v1::models::Classification;
use crate::common::api_endpoints::LingoApiV1;

/// 获取词典分类响应（data）
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ListClassificationResp {
    /// 分类列表
    #[serde(default)]
    pub items: Vec<Classification>,
    /// 分页标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 是否还有更多项
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_more: Option<bool>,
}

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

/// 获取词典分类请求
pub struct ListClassificationRequest {
    config: Config,
    page_size: Option<i32>,
    page_token: Option<String>,
    repo_id: Option<String>,
}

impl ListClassificationRequest {
    /// 创建新的实例。
    pub fn new(config: Config) -> Self {
        Self {
            config,
            page_size: None,
            page_token: None,
            repo_id: None,
        }
    }

    /// 分页大小（默认 20，范围 1~500）
    pub fn page_size(mut self, page_size: i32) -> Self {
        self.page_size = Some(page_size);
        self
    }

    /// 分页标记
    pub fn page_token(mut self, page_token: impl Into<String>) -> Self {
        self.page_token = Some(page_token.into());
        self
    }

    /// 词库ID（不传默认全员词库）
    pub fn repo_id(mut self, repo_id: impl Into<String>) -> Self {
        self.repo_id = Some(repo_id.into());
        self
    }

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

    /// 使用指定请求选项执行请求。
    pub async fn execute_with_options(
        self,
        option: RequestOption,
    ) -> SDKResult<ListClassificationResp> {
        // ===== 构建请求 =====
        let mut api_request: ApiRequest<ListClassificationResp> =
            ApiRequest::get(&LingoApiV1::ClassificationList.to_url());
        if let Some(page_size) = self.page_size {
            api_request = api_request.query("page_size", &page_size.to_string());
        }
        if let Some(page_token) = &self.page_token {
            api_request = api_request.query("page_token", page_token);
        }
        if let Some(repo_id) = &self.repo_id {
            api_request = api_request.query("repo_id", repo_id);
        }

        // ===== 发送请求 =====
        let response: Response<ListClassificationResp> =
            Transport::request(api_request, &self.config, Some(option)).await?;
        response
            .data
            .ok_or_else(|| openlark_core::error::validation_error("response", "响应数据为空"))
    }
}

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

    #[test]
    fn test_list_classification_request_builder() {
        let config = Config::default();
        let request = ListClassificationRequest::new(config);

        assert!(request.page_size.is_none());
        assert!(request.page_token.is_none());
        assert!(request.repo_id.is_none());
    }

    #[test]
    fn test_list_classification_request_with_params() {
        let config = Config::default();
        let request = ListClassificationRequest::new(config)
            .page_size(50)
            .page_token("token")
            .repo_id("repo_123");

        assert_eq!(request.page_size, Some(50));
        assert_eq!(request.page_token, Some("token".to_string()));
        assert_eq!(request.repo_id, Some("repo_123".to_string()));
    }

    #[test]
    fn test_response_structure() {
        let response = ListClassificationResp {
            items: vec![],
            page_token: Some("next".to_string()),
            has_more: Some(true),
        };

        assert!(response.items.is_empty());
        assert_eq!(response.page_token, Some("next".to_string()));
        assert_eq!(response.has_more, Some(true));
    }

    #[test]
    fn test_response_trait() {
        assert_eq!(ListClassificationResp::data_format(), ResponseFormat::Data);
    }
}