open-lark 0.13.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,
        http::Transport,
        req_option::RequestOption,
        SDKResult,
    },
    service::workplace::models::{AppRecommendRule, FavouriteApp, PageResponse, RecommendedApp},
};

/// 应用推荐服务
pub struct AppRecommendService {
    pub config: Config,
}

impl AppRecommendService {
    /// 创建应用推荐服务实例
    pub fn new(config: Config) -> Self {
        Self { config }
    }

    /// 获取用户自定义常用的应用
    ///
    /// 获取当前用户自定义设置的常用应用列表。
    ///
    /// # Arguments
    ///
    /// * `request` - 常用应用查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回用户常用应用列表
    pub async fn get_favourite_apps(
        &self,
        request: FavouriteAppsRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<FavouriteAppsResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: "/open-apis/workplace/v1/app_recommend_rule/favourite".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("page_token".to_string(), page_token);
        }

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

        if let Some(user_id) = request.user_id {
            api_req.query_params.insert("user_id".to_string(), user_id);
        }

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

    /// 获取管理员推荐的应用
    ///
    /// 获取管理员设置的推荐应用列表。
    ///
    /// # Arguments
    ///
    /// * `request` - 推荐应用查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回管理员推荐应用列表
    pub async fn get_recommended_apps(
        &self,
        request: RecommendedAppsRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RecommendedAppsResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: "/open-apis/workplace/v1/app_recommend_rule/recommend".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("page_token".to_string(), page_token);
        }

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

        if let Some(user_id) = request.user_id {
            api_req.query_params.insert("user_id".to_string(), user_id);
        }

        if let Some(department_id) = request.department_id {
            api_req
                .query_params
                .insert("department_id".to_string(), department_id);
        }

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

    /// 获取当前设置的推荐规则列表
    ///
    /// 获取当前系统中配置的应用推荐规则列表。
    ///
    /// # Arguments
    ///
    /// * `request` - 推荐规则查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回推荐规则列表
    pub async fn list_recommend_rules(
        &self,
        request: RecommendRulesListRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<RecommendRulesListResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: "/open-apis/workplace/v1/app_recommend_rule/list".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("page_token".to_string(), page_token);
        }

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

        if let Some(rule_type) = request.rule_type {
            api_req
                .query_params
                .insert("rule_type".to_string(), rule_type);
        }

        if let Some(status) = request.status {
            api_req.query_params.insert("status".to_string(), status);
        }

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

/// 常用应用查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct FavouriteAppsRequest {
    /// 页码标记
    #[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 user_id: Option<String>,
}

/// 常用应用查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct FavouriteAppsResponse {
    /// 常用应用列表
    #[serde(flatten)]
    pub favourite_apps: PageResponse<FavouriteApp>,
}

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

/// 推荐应用查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct RecommendedAppsRequest {
    /// 页码标记
    #[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 user_id: Option<String>,
    /// 部门ID筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub department_id: Option<String>,
}

/// 推荐应用查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct RecommendedAppsResponse {
    /// 推荐应用列表
    #[serde(flatten)]
    pub recommended_apps: PageResponse<RecommendedApp>,
}

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

/// 推荐规则列表查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct RecommendRulesListRequest {
    /// 页码标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 每页数量
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 规则类型筛选
    #[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 RecommendRulesListResponse {
    /// 推荐规则列表
    #[serde(flatten)]
    pub recommend_rules: PageResponse<AppRecommendRule>,
}

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