open-lark 0.14.0

Enterprise-grade Lark/Feishu Open API SDK with comprehensive Chinese documentation and advanced error handling
Documentation
use reqwest::Method;
use serde::{Deserialize, Serialize};

use crate::{
    core::{
        api_req::ApiRequest,
        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
        config::Config,
        constants::AccessTokenType,
        endpoints::{EndpointBuilder, Endpoints},
        http::Transport,
        query_params::QueryParams,
        req_option::RequestOption,
        SDKResult,
    },
    service::trust_party::models::{PageResponse, RuleConfig, SearchableVisibleRule},
};

/// 可搜可见规则管理服务
pub struct SearchableVisibleRulesService {
    pub config: Config,
}

impl SearchableVisibleRulesService {
    /// 创建可搜可见规则管理服务实例
    pub fn new(config: Config) -> Self {
        Self { config }
    }

    /// 新增可搜可见规则
    ///
    /// 创建新的可搜可见规则,用于控制用户在关联组织中的可见性和搜索权限。
    ///
    /// # Arguments
    ///
    /// * `request` - 规则创建请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回创建的规则信息
    pub async fn create_rule(
        &self,
        request: RuleCreateRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RuleCreateResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::TRUST_PARTY_V1_SEARCHABLE_VISIBLE_RULES.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 更新可搜可见规则
    ///
    /// 更新指定的可搜可见规则配置。
    ///
    /// # Arguments
    ///
    /// * `rule_id` - 规则ID
    /// * `request` - 规则更新请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回更新后的规则信息
    pub async fn update_rule(
        &self,
        rule_id: &str,
        request: RuleUpdateRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RuleUpdateResponse>> {
        let api_req = ApiRequest {
            http_method: Method::PUT,
            api_path: EndpointBuilder::replace_param(
                Endpoints::TRUST_PARTY_V1_SEARCHABLE_VISIBLE_RULE_OPERATION,
                "rule_id",
                rule_id,
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 查询可搜可见规则
    ///
    /// 查询可搜可见规则列表,支持分页和条件筛选。
    ///
    /// # Arguments
    ///
    /// * `request` - 规则查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回规则列表
    pub async fn list_rules(
        &self,
        request: RuleListRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RuleListResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: Endpoints::TRUST_PARTY_V1_SEARCHABLE_VISIBLE_RULES.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        // 添加查询参数
        if let Some(page_token) = request.page_token {
            api_req
                .query_params
                .insert(QueryParams::PAGE_TOKEN, page_token);
        }

        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert(QueryParams::PAGE_SIZE, page_size.to_string());
        }

        if let Some(org_id) = request.org_id {
            api_req.query_params.insert(QueryParams::ORG_ID, org_id);
        }

        if let Some(rule_type) = request.rule_type {
            api_req
                .query_params
                .insert(QueryParams::RULE_TYPE, rule_type);
        }

        if let Some(status) = request.status {
            api_req.query_params.insert(QueryParams::STATUS, status);
        }

        Transport::request(api_req, &self.config, option).await
    }

    /// 删除可搜可见规则
    ///
    /// 删除指定的可搜可见规则。
    ///
    /// # Arguments
    ///
    /// * `rule_id` - 规则ID
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回删除结果
    pub async fn delete_rule(
        &self,
        rule_id: &str,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RuleDeleteResponse>> {
        let api_req = ApiRequest {
            http_method: Method::DELETE,
            api_path: EndpointBuilder::replace_param(
                Endpoints::TRUST_PARTY_V1_SEARCHABLE_VISIBLE_RULE_OPERATION,
                "rule_id",
                rule_id,
            ),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }
}

/// 规则创建请求
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RuleCreateRequest {
    /// 规则名称
    pub name: String,
    /// 规则描述
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// 规则类型
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rule_type: Option<String>,
    /// 适用的组织ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub org_id: Option<String>,
    /// 规则配置
    #[serde(skip_serializing_if = "Option::is_none")]
    pub config: Option<RuleConfig>,
}

/// 规则创建响应
#[derive(Debug, Serialize, Deserialize)]
pub struct RuleCreateResponse {
    /// 创建的规则信息
    pub rule: SearchableVisibleRule,
}

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

/// 规则更新请求
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RuleUpdateRequest {
    /// 规则名称
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// 规则描述
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// 规则类型
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rule_type: Option<String>,
    /// 规则状态
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    /// 规则配置
    #[serde(skip_serializing_if = "Option::is_none")]
    pub config: Option<RuleConfig>,
}

/// 规则更新响应
#[derive(Debug, Serialize, Deserialize)]
pub struct RuleUpdateResponse {
    /// 更新后的规则信息
    pub rule: SearchableVisibleRule,
}

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

/// 规则列表查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct RuleListRequest {
    /// 页码标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 每页数量
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 组织ID筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub org_id: Option<String>,
    /// 规则类型筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rule_type: Option<String>,
    /// 状态筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
}

/// 规则列表查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct RuleListResponse {
    /// 规则列表
    #[serde(flatten)]
    pub rules: PageResponse<SearchableVisibleRule>,
}

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

/// 规则删除响应
#[derive(Debug, Serialize, Deserialize)]
pub struct RuleDeleteResponse {
    /// 删除成功标识
    pub success: bool,
}

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