Struct Client 

pub struct Client { /* private fields */ }

Implementations

impl Client

pub fn new( plugin_id: impl Into<String>, plugin_secret: impl Into<String>, base_url: Option<impl Into<String>>, ) -> Self

Trait Implementations

impl BusinessApi for Client

async fn get_business_list( &self, request: GetBusinessListRequest, auth: AuthType, ) -> ApiResult<GetBusinessListResponse>

获取空间下业务线详情 该接口用于获取查询空间的业务线信息，对应进行业务线配置的平台功能可参考业务线配置。

impl ChatApi for Client

async fn bot_join_chat( &self, request: BotJoinChatRequest, auth: AuthType, ) -> ApiResult<BotJoinChatResponse>

拉机器人入群 该接口用于将指定的飞书机器人拉入工作项关联群，且群里必须有飞书项目机器人 对应的平台功能，如绑定飞书群可参考绑定飞书群。 对应的权限申请在权限管理-群组分类下，相关功能介绍详见权限管理。

impl CommentApi for Client

async fn create_comment( &self, request: CreateCommentRequest, auth: AuthType, ) -> ApiResult<CreateCommentResponse>

添加评论 该接口用于在指定工作项下添加一条评论，添加的评论内容会出现在工作项详情页——评论/备注tab页中，并会显示该评论由插件添加。

async fn get_comments( &self, request: GetCommentsRequest, auth: AuthType, ) -> ApiResult<GetCommentsResponse>

获取评论 该接口用于获取指定工作项下的所有评论信息

async fn update_comment( &self, request: UpdateCommentRequest, auth: AuthType, ) -> ApiResult<UpdateCommentResponse>

更新评论 该接口用于对指定评论更新其内容，被更新的评论会显示该评论由插件添加。

async fn delete_comment( &self, request: DeleteCommentRequest, auth: AuthType, ) -> ApiResult<DeleteCommentResponse>

删除评论 该接口用于删除工作项下一条指定的评论信息

impl FieldApi for Client

async fn list_fields( &self, project_key: &str, request: ListFieldsRequest, auth: AuthType, ) -> ApiResult<ListFieldsResponse>

获取指定空间或工作项类型下所有“字段“的基础信息

async fn create_field( &self, project_key: &str, work_item_type_key: &str, request: CreateFieldRequest, auth: AuthType, ) -> ApiResult<CreateFieldResponse>

在指定工作项类型下创建一个新的“自定义字段“

async fn update_field( &self, project_key: &str, work_item_type_key: &str, request: UpdateFieldRequest, auth: AuthType, ) -> ApiResult<UpdateFieldResponse>

更新指定自定义字段的配置信息

impl FileApi for Client

async fn upload_work_item_file( &self, request: UploadWorkItemFileRequest, auth: AuthType, ) -> ApiResult<UploadWorkItemFileResponse>

添加附件 该接口用于在指定工作项的一个“附件类型“字段中添加附件，对应的插件应用效果可参考上传附件。

async fn upload_file( &self, request: UploadFileRequest, auth: AuthType, ) -> ApiResult<UploadFileResponse>

上传文件或富文本图片 该接口为通用的文件上传接口，会返回上传后的资源路径，主要用于富文本中上传图片。

async fn download_work_item_file( &self, request: DownloadWorkItemFileRequest, auth: AuthType, ) -> ApiResult<DownloadWorkItemFileResponse>

下载附件 该接口用于下载一个工作项下的指定附件。

async fn delete_file( &self, request: DeleteFileRequest, auth: AuthType, ) -> ApiResult<DeleteFileResponse>

删除附件 该接口用于在指定工作项的一个“附件类型“字段中删除附件。

impl FinishedApi for Client

async fn batch_query_finished( &self, request: BatchQueryFinishedRequest, auth: AuthType, ) -> ApiResult<BatchQueryFinishedResponse>

批量查询评审意见、评审结论 该接口用于批量查询节点的评审意见和结论。

async fn update_finished( &self, request: UpdateFinishedRequest, auth: AuthType, ) -> ApiResult<UpdateFinishedResponse>

更新节点评审意见和结论 该接口用于更新节点评审意见和结论，或执行置空操作。

async fn query_conclusion_option( &self, request: QueryConclusionOptionRequest, auth: AuthType, ) -> ApiResult<QueryConclusionOptionResponse>

获取评审结论标签值 该接口用于查询节点下配置的评审结论标签。

impl MeasureApi for Client

async fn get_measure_chart_detail( &self, request: GetMeasureChartDetailRequest, auth: AuthType, ) -> ApiResult<GetMeasureChartDetailResponse>

获取度量图表明细数据 该接口用于获取一个指定度量图表的明细数据，对应的平台功能，如度量的功能使用可参考飞书项目度量介绍。 对应的权限申请在权限管理-度量分类下，相关功能介绍详见权限管理。

impl ProjectApi for Client

async fn list_projects( &self, request: ListProjectRequest, auth: AuthType, ) -> ApiResult<ListProjectResponse>

async fn get_projects_detail( &self, request: GetProjectDetailRequest, auth: AuthType, ) -> ApiResult<GetProjectDetailResponse>

impl ProjectRelationApi for Client

async fn get_project_relation_rules( &self, request: GetProjectRelationRulesRequest, auth: AuthType, ) -> ApiResult<GetProjectRelationRulesResponse>

获取空间关联规则列表 该接口用于获取指定空间下配置的空间关联规则列表，对应的平台功能介绍可参考空间关联规则配置

async fn get_relation_instances( &self, request: GetRelationInstancesRequest, auth: AuthType, ) -> ApiResult<GetRelationInstancesResponse>

获取空间关联下的关联工作项实例列表 该接口用于获取与指定工作项实例有空间关联的工作项实例列表

async fn batch_bind_relation( &self, request: BatchBindRelationRequest, auth: AuthType, ) -> ApiResult<BatchBindRelationResponse>

批量绑定工作项实例 该接口用于将指定工作项实例和传入的工作项实例列表建立空间关联绑定关系

async fn unbind_relation( &self, request: UnbindRelationRequest, auth: AuthType, ) -> ApiResult<UnbindRelationResponse>

解绑空间关联的关联工作项实例 该接口用于将指定工作项实例和传入的工作项实例解除空间关联绑定关系

impl RoleApi for Client

async fn get_role_config( &self, request: GetRoleConfigRequest, auth: AuthType, ) -> ApiResult<GetRoleConfigResponse>

获取流程角色配置详情 该接口用于获取指定工作项类型下所有“角色与人员“的相关配置信息，对应的平台功能介绍详见常见问题：角色管理。 对应的权限申请在权限管理-流程角色分类下，相关功能介绍详见权限管理。

impl SubTaskApi for Client

async fn create_subtask( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, request: CreateSubTaskRequest, auth: AuthType, ) -> ApiResult<i64>

创建子任务 该接口用于在一个工作项实例的指定节点上创建一个子任务，对应平台的功能可参考新增任务。 对应的权限申请在权限管理-子任务分类下，相关功能介绍详见权限管理。

async fn update_subtask( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, node_id: &str, task_id: i64, request: UpdateSubTaskRequest, auth: AuthType, ) -> ApiResult<()>

更新子任务 该接口用于更新工作项实例指定节点上的一个子任务详细信息，对应平台的功能， 如实例侧操作可参考任务管理，如流程节点上默认的子任务配置可参考完成任务。

async fn delete_subtask( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, task_id: i64, auth: AuthType, ) -> ApiResult<()>

删除子任务 该接口用于删除指定工作项实例中的一个子任务，对应平台的功能可参考任务管理。 对应的权限申请在权限管理-子任务分类下，相关功能介绍详见权限管理。

async fn modify_subtask( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, request: ModifySubTaskRequest, auth: AuthType, ) -> ApiResult<()>

子任务完成/回滚 该接口用于完成或者回滚工作项实例指定节点上的一个子任务，对应平台的功能， 如实例侧操作可参考任务管理，如流程节点上默认的子任务配置可参考完成任务。 对应的权限申请在权限管理-子任务分类下，相关功能介绍详见权限管理。

async fn get_subtasks( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, node_id: Option<&str>, auth: AuthType, ) -> ApiResult<GetSubTaskResponse>

获取指定工作项实例上的子任务详细信息 该接口用于获取指定工作项实例上的子任务详细信息，对应平台的功能， 如实例侧操作可参考任务管理，如流程节点上默认的子任务配置可参考完成任务。 对应的权限申请在权限管理-子任务分类下，相关功能介绍详见权限管理。

async fn search_subtasks( &self, request: SearchSubTaskRequest, auth: AuthType, ) -> ApiResult<SearchSubTaskResponse>

获取指定的子任务列表（跨空间） 该接口用于跨空间搜索符合传入条件的子任务，对应平台的功能， 如实例侧操作可参考任务管理，如流程节点上默认的子任务配置可参考完成任务。 对应的权限申请在权限管理-子任务分类下，相关功能介绍详见权限管理。

impl UserApi for Client

async fn get_teams( &self, project_key: String, auth: AuthType, ) -> ApiResult<GetTeamsResponse>

获取空间下团队人员

async fn search_users( &self, request: SearchUsersRequest, auth: AuthType, ) -> ApiResult<Value>

搜索租户内的用户列表

async fn get_user_detail( &self, request: GetUserDetailRequest, auth: AuthType, ) -> ApiResult<Value>

获取用户详情

impl UserGroupApi for Client

async fn get_user_group_members( &self, request: GetUserGroupMembersRequest, auth: AuthType, ) -> ApiResult<Value>

获取用户组成员 该接口用于获取用户组成员，对应的平台功能介绍可参考用户组管理。

async fn create_user_group( &self, request: CreateUserGroupRequest, auth: AuthType, ) -> ApiResult<CreateUserGroupResponse>

创建自定义用户组 该接口用于创建自定义用户组，对应的平台功能介绍，如创建用户组的平台功能可参考用户组管理。

async fn update_user_group_members( &self, request: UpdateUserGroupMembersRequest, auth: AuthType, ) -> ApiResult<UpdateUserGroupMembersResponse>

更新用户组成员 该接口用于更新用户组成员，对应的平台功能介绍可参考用户组管理。

impl ViewApi for Client

async fn get_view_list( &self, request: GetViewListRequest, auth: AuthType, ) -> ApiResult<GetViewListResponse>

获取视图列表及配置信息 该接口用于在指定空间，搜索符合请求参数中传入条件的视图列表及相关配置信息

async fn get_fix_view( &self, request: GetFixViewRequest, auth: AuthType, ) -> ApiResult<GetFixViewResponse>

获取视图下工作项列表 该接口用于获取指定视图中的所有工作项实例列表

async fn get_panoramic_view( &self, request: GetPanoramicViewRequest, auth: AuthType, ) -> ApiResult<GetPanoramicViewResponse>

获取视图下工作项列表（全景视图） 该接口用于获取指定全景视图中的所有工作项实例列表和详情信息

async fn create_fix_view( &self, request: CreateFixViewRequest, auth: AuthType, ) -> ApiResult<CreateFixViewResponse>

创建固定视图 该接口用于在指定空间和工作项类型下新增一个固定视图

async fn update_fix_view( &self, request: UpdateFixViewRequest, auth: AuthType, ) -> ApiResult<UpdateFixViewResponse>

更新固定视图 该接口用于添加或删除固定视图中的工作项

async fn create_condition_view( &self, request: CreateConditionViewRequest, auth: AuthType, ) -> ApiResult<CreateConditionViewResponse>

创建条件视图 该接口用于在指定空间和工作项类型下新增一个条件视图

async fn update_condition_view( &self, request: UpdateConditionViewRequest, auth: AuthType, ) -> ApiResult<UpdateConditionViewResponse>

更新条件视图 该接口用于对一个指定条件视图更新其筛选条件和协作者信息

async fn delete_view( &self, request: DeleteViewRequest, auth: AuthType, ) -> ApiResult<DeleteViewResponse>

删除视图 该接口用于删除指定空间的一个视图，支持条件、固定以及全景视图

impl WorkHourApi for Client

async fn get_work_hour_records( &self, request: GetWorkHourRecordsRequest, auth: AuthType, ) -> ApiResult<GetWorkHourRecordsResponse>

获取工作项的工时记录列表 该接口仅在安装使用官方插件-[工时登记]时有效，用于获取指定空间和工作项类型下的指定工作项实例的工时记录详细信息

async fn create_work_hour_record( &self, request: CreateWorkHourRecordRequest, auth: AuthType, ) -> ApiResult<CreateWorkHourRecordResponse>

创建实际工时 该接口仅在安装使用官方插件-[工时登记]时有效，用于指定空间和工作项类型下的指定工作项实例下添加工时记录信息

async fn update_work_hour_record( &self, request: UpdateWorkHourRecordRequest, auth: AuthType, ) -> ApiResult<UpdateWorkHourRecordResponse>

更新实际工时 该接口仅在安装使用官方插件-[工时登记]时有效，用于更新指定空间和工作项类型下的指定工作项实例的某个操作者的多个工时记录

async fn delete_work_hour_record( &self, request: DeleteWorkHourRecordRequest, auth: AuthType, ) -> ApiResult<DeleteWorkHourRecordResponse>

删除工时记录 该接口仅在安装并使用官方插件-[工时登记]时有效，用于删除指定空间和工作项类型下的指定工作项实例的某个操作者的多个工时记录

impl WorkItemApi for Client

async fn filter_work_items_in_project( &self, project_key: String, request: FilterWorkItemsInProjectRequest, auth: AuthType, ) -> ApiResult<FilterWorkItemsInProjectResponse>

在指定空间，搜索符合请求参数中传入条件的工作项实例

async fn filter_work_items_across_projects( &self, request: FilterWorkItemsAcrossProjectsRequest, auth: AuthType, ) -> ApiResult<FilterWorkItemsAcrossProjectsResponse>

跨多个空间，搜索符合请求参数中传入条件的工作项实例

async fn search_work_items_in_project( &self, project_key: String, work_item_type_key: String, request: SearchWorkItemsInProjectRequest, auth: AuthType, ) -> ApiResult<SearchWorkItemsInProjectResponse>

获取指定的工作项列表（单空间-复杂传参） 该接口用于在指定空间，搜索符合“复杂筛选条件“的工作项实例。

async fn compositive_search( &self, request: CompositiveSearchRequest, auth: AuthType, ) -> ApiResult<CompositiveSearchResponse>

获取指定的工作项列表（全局搜索） 该接口用于按照标题、描述、人员等多字段，跨空间和工作项类型搜索符合条件的工作项实例列表

async fn search_work_items_by_relation( &self, project_key: String, work_item_type_key: String, work_item_id: String, request: SearchWorkItemsByRelationRequest, auth: AuthType, ) -> ApiResult<SearchWorkItemsByRelationResponse>

获取指定的关联工作项列表（单空间） 该接口用于获取与指定工作项实例存在工作项关联的工作项实例列表

async fn get_work_item_details( &self, project_key: String, work_item_type_key: String, request: GetWorkItemDetailsRequest, auth: AuthType, ) -> ApiResult<GetWorkItemDetailsResponse>

获取工作项详情 该接口用于获取指定空间和工作项类型下的一个工作项实例的详细信息

async fn get_work_item_meta( &self, project_key: String, work_item_type_key: String, auth: AuthType, ) -> ApiResult<GetWorkItemMetaResponse>

获取创建工作项元数据 该接口用于获取指定工作项类型的“元数据“，它是创建一个工作项实例的最小数据单元

async fn create_work_item( &self, project_key: String, request: CreateWorkItemRequest, auth: AuthType, ) -> ApiResult<CreateWorkItemResponse>

创建工作项 该接口用于在指定空间和工作项类型下新增一个“工作项实例“

async fn update_work_item( &self, project_key: String, work_item_type_key: String, work_item_id: String, request: UpdateWorkItemRequest, auth: AuthType, ) -> ApiResult<UpdateWorkItemResponse>

更新工作项 该接口用于修改指定空间和工作项类型下的一个“工作项实例“

async fn batch_update_work_items( &self, request: BatchUpdateWorkItemRequest, auth: AuthType, ) -> ApiResult<BatchUpdateWorkItemResponse>

批量更新工作项字段值 该接口用于批量更新指定空间和工作项类型下的多个“工作项实例“

async fn get_batch_update_result( &self, task_id: String, auth: AuthType, ) -> ApiResult<TaskResultResponse>

获取批量更新处理进度 该接口用于获取批量更新工作项字段值接口提交的任务处理进度

async fn batch_query_deliverable( &self, request: BatchQueryDeliverableRequest, auth: AuthType, ) -> ApiResult<BatchQueryDeliverableResponse>

批量查询交付物信息 该接口用于查询交付物详情信息

async fn delete_work_item( &self, project_key: String, work_item_type_key: String, work_item_id: i64, auth: AuthType, ) -> ApiResult<Value>

删除工作项 该接口用于删除指定空间和工作项类型下的一个“工作项实例“

async fn abort_work_item( &self, project_key: String, work_item_type_key: String, work_item_id: i64, request: AbortWorkItemRequest, auth: AuthType, ) -> ApiResult<AbortWorkItemResponse>

终止/恢复工作项 该接口用于终止或者恢复指定空间和工作项类型下的一个“工作项实例“

async fn freeze_work_item( &self, request: FreezeWorkItemRequest, auth: AuthType, ) -> ApiResult<FreezeWorkItemResponse>

冻结/解冻工作项实例 该接口用于冻结/解冻工作项实例

async fn get_work_item_operation_records( &self, request: GetWorkItemOperationRecordRequest, auth: AuthType, ) -> ApiResult<GetWorkItemOperationRecordResponse>

获取工作项操作记录 该接口用于获取指定空间下的多个工作项实例的操作记录

impl WorkItemRelationApi for Client

async fn get_work_item_relation_list( &self, request: GetWorkItemRelationListRequest, auth: AuthType, ) -> ApiResult<GetWorkItemRelationListResponse>

获取工作项关系列表 该接口用于获取指定空间下的“工作项关联关系“列表，对应的平台功能介绍详见关系管理。

async fn create_work_item_relation( &self, request: CreateWorkItemRelationRequest, auth: AuthType, ) -> ApiResult<WorkItemRelationResponse>

创建工作项关联关系 该接口用于在指定空间下新增一个“工作项关联关系“，对应的平台功能介绍详见关系管理。

async fn update_work_item_relation( &self, request: UpdateWorkItemRelationRequest, auth: AuthType, ) -> ApiResult<WorkItemRelationResponse>

更新工作项关系 该接口用于更新指定工作项关系的配置信息，对应的平台功能介绍详见关系管理。

async fn delete_work_item_relation( &self, request: DeleteWorkItemRelationRequest, auth: AuthType, ) -> ApiResult<WorkItemRelationResponse>

删除工作项关联关系 该接口用于删除指定空间下的“工作项关联关系“，对应的平台功能介绍详见关系管理。

impl WorkItemTypeApi for Client

async fn get_work_item_types( &self, request: GetWorkItemTypesRequest, auth: AuthType, ) -> ApiResult<GetWorkItemTypesResponse>

获取空间下工作项类型 该接口用于获取空间下所有的工作项类型的对接标识（获取后续接口的work_item_type_key参数）

async fn get_work_item_type_config( &self, request: GetWorkItemTypeConfigRequest, auth: AuthType, ) -> ApiResult<GetWorkItemTypeConfigResponse>

获取工作项基础信息配置 该接口用于获取指定工作项类型的基础信息配置

async fn update_work_item_type_config( &self, request: UpdateWorkItemTypeConfigRequest, auth: AuthType, ) -> ApiResult<UpdateWorkItemTypeConfigResponse>

更新工作项基础信息配置 该接口用于更新指定工作项类型的基础信息配置

impl WorkflowApi for Client

async fn update_node( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, node_id: &str, request: UpdateNodeRequest, auth: AuthType, ) -> ApiResult<Value>

更新工作项实例的指定节点信息

async fn operate_node( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, node_id: &str, request: OperateNodeRequest, auth: AuthType, ) -> ApiResult<Value>

完成或回滚工作项实例的指定节点

async fn change_state( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, request: ChangeStateRequest, auth: AuthType, ) -> ApiResult<Value>

状态流转

async fn get_workflow_wbs( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, expand: Option<ExPand>, auth: AuthType, ) -> ApiResult<WbsViewResponse>

获取工作流详情（WBS）

async fn get_workflow_detail( &self, project_key: &str, work_item_type_key: &str, work_item_id: i64, request: GetWorkflowDetailRequest, auth: AuthType, ) -> ApiResult<NodesConnections>

获取工作流详情

impl WorkflowTemplateApi for Client

async fn get_workflow_template_list( &self, request: GetWorkflowTemplateListRequest, auth: AuthType, ) -> ApiResult<GetWorkflowTemplateListResponse>

获取工作项下的流程模板列表 该接口用于获取指定工作项类型下所有“流程模板“列表

async fn get_workflow_template_detail( &self, request: GetWorkflowTemplateDetailRequest, auth: AuthType, ) -> ApiResult<GetWorkflowTemplateDetailResponse>

获取流程模板配置详情 该接口用于获取指定流程模板的配置信息详情

async fn create_workflow_template( &self, request: CreateWorkflowTemplateRequest, auth: AuthType, ) -> ApiResult<CreateWorkflowTemplateResponse>

创建流程模板 该接口用于在指定工作项类型下创建一个新的“流程模板“

async fn update_workflow_template( &self, request: UpdateWorkflowTemplateRequest, auth: AuthType, ) -> ApiResult<UpdateWorkflowTemplateResponse>

更新流程模板 该接口用于更新指定流程模板的配置信息

async fn delete_workflow_template( &self, request: DeleteWorkflowTemplateRequest, auth: AuthType, ) -> ApiResult<DeleteWorkflowTemplateResponse>

删除流程模板 该接口用于删除指定的流程模板